Hostway API Documentation - User contributions [en]

ProductSpecifications-productSpecificationId-offerings-offeringId-prices:GET

2016-06-01T16:01:08Z

Jerry.dimitrov: /* Parameters */

= GET /productSpecifications/''{productSpecificationId}''/offerings/''{offeringId}''/prices =
Retrieves prices for a particular product specification offering.
__TOC__

== Request ==
<code>GET /productSpecifications/''{productSpecificationId}''/offerings/''{offeringId}''/prices</code>

=== URI Parameters ===
;filterType
: Indicates that the result should be filtered by price type.
: The legal values for this parameter are 'fee', 'discount' and 'usage_fee'
: '''''fee''''' - all product specification and its service specifications prices (e.g. setup fee, recurring fee, etc.)
: '''''discount''''' - all product specification and its service specifications discounts
: '''''usage_fee''''' - all product specification and its service specifications usage prices
: This parameter CANNOT be used with values containing any wildcards (*)

: This parameter is optional

;filterRecurrences
: Indicates that the result should be filtered by the number of recurrences
: This parameter is optional.
: The values for this parameter can be specified using a wildcard(*).

;filterRelatedServiceSpecification
: Indicates that the result should be filtered by linked service specification URI.
: A value of '' indicates that only results with relatedServiceSpecification='' should be returned.
: This parameter is optional
: This parameter CANNOT be used with values containing any wildcards (*)

;filterName
: Indicates that the result should be filtered by name
: This parameter is optional
: This parameter CANNOT be used with values containing any wildcards (*)

;sortField
: Indicates which field should be used for sorting.
: Legal values are 'name', 'type', 'recurrences' and 'relatedServiceSpecification'.
: This parameter is optional

;sortOrder
: Indicates the order in which the result should be sorted.
: Legal values are 'asc' and 'desc'
: This parameter is optional. If 'sortField' was specified and 'sortOrder' was omitted, then the result will be sorted in ascending order.

;pageSize
: Indicates the number of prices to be included on each page of the result (if pagination is desired)
: This parameter is optional. If 'page' is specified and 'pageSize' is omitted, then the result will show 100 prices per page.

;page
: Indicates the 1-based index of the page to view.
: The value must be an integer between 1 and the maximum number of pages (returned in the 'last' element of the 'links' attribute of the result)
: This parameter is optional, but if 'pageSize' was specified, then 'page' is also required.

== Response ==
Returns a list of prices for a particular product specification offering Id.

=== Status Code ===
;200 OK
: Success

;400 Bad Request
: Returned if incorrect parameters are specified for filtering, sorting or pagination. The response body will contain details about the nature of the error.

;404 Not Found
: Returned if the product specification Id or the offering Id could not be found.

;502 Bad Gateway
: Returned there is any internal API error.

=== Response Body ===
<nowiki>
{
"list": [
{
"type": "fee"
"name": "recurring",
"amount": 1125.0,
"amountType": "retail",
"deferred": 1,
"billingPeriod": 3,
"recurrences": -1,
"relatedServiceSpecification": "",
},
{
"type": "fee"
"name": "recurring",
"amount": 1125.0,
"amountType": "retail",
"deferred": 1,
"billingPeriod": 3,
"recurrences": -1,
"relatedServiceSpecification": "</nowiki>{{APIBaseURL}}<nowiki>/serviceSpecifications/{serviceSpecificationId}",
},
{
"type" : "usage_fee",
"name" : "mfg_mailbox_standard",
"billingPeriod" : 1,
"relatedServiceSpecification" : "</nowiki>{{APIBaseURL}}<nowiki>/serviceSpecifications/{serviceSpecificationId}",
"unit" : "mfg_mailbox_standard",
"rates" : [
{
"start" : 1.0,
"end" : 3.0,
"pricePerIncrement" : 0.0,
"includedPrice": 0.0,
"increment": 1.0
},
{
"start" : 3.0,
"end" : -1.0,
"pricePerIncrement" : 1.0,
"includedPrice": 3.0,
"increment": 1.0
}
]
}
],
"links": [
{
"rel": "self",
"href": "</nowiki>{{APIBaseURL}}<nowiki>/productSpecifications/{productSpecificationId}/offerings/{offeringId}/prices?pageSize={pageSize}&page=3"
},
{
"rel": "first",
"href": "</nowiki>{{APIBaseURL}}<nowiki>/productSpecifications/{productSpecificationId}/offerings/{offeringId}/prices?pageSize={pageSize}&page=1"
},
{
"rel": "previous",
"href": "</nowiki>{{APIBaseURL}}<nowiki>/productSpecifications/{productSpecificationId}/offerings/{offeringId}/prices?pageSize={pageSize}&page=2"
},
{
"rel": "next",
"href": "</nowiki>{{APIBaseURL}}<nowiki>/productSpecifications/{productSpecificationId}/offerings/{offeringId}/prices?pageSize={pageSize}&page=4"
},
{
"rel": "last",
"href": "</nowiki>{{APIBaseURL}}<nowiki>/productSpecifications/{productSpecificationId}/offerings/{offeringId}/prices?pageSize={pageSize}&page=12"
},
]
} </nowiki>

==== Parameters ====
; list - ''list''
: List of product offering price details. Each element of the list has the following attributes:

:; type - ''string''
:: This can be either 'fee', 'discount' or 'usage_fee'. A fee represents a fee that will be charged. A discount represents a downward adjustment of the amount of a fee. An usage fee represents a fee that will be charged based on usage rate.

:; amountType - ''string''
:: Possible values: 'retail'. Indicates the type of the fee amount.
:: This parameter is available for '''''fee''''' types only

:; deferred - ''integer''
:: All fees (product and service specific fees) have deferred flag, which is showing whether the product/service has a delayed billing.

:; name - ''string''
:: A name for the price. This is NOT guaranteed to be unique.

:; billingPeriod - ''integer''
:: The billing frequency in months.

:; recurrences - ''integer''
:: The number of time this price will recur. A value of -1 means that the price will recur throughout the entire lifetime of the provisioned product.
:: This parameter is available for '''''fee''''' and '''''discount''''' types only

:; relatedServiceSpecification - ''string''
:: The URI of the service specification (associated with the product) to which this price is linked. If this is an empty string, then the price is linked to the product itself.

:; unit - ''string''
:: unit based on which a service is charged for.
:: This parameter is available for '''''usage_fee''''' type only

:; rates - ''dictionary''
:: tiers of usage on which a service is charged for. Each tier has:
::; start - ''float''
::: number of unit for which a service begins to be charged with the '''current''' tier's price. The start of a tier is '''inclusive for the current tier'''.

::; end - ''float''
::: number of unit for which a service begins to be charged with the '''next''' tier's price. The end of a tier is '''exclusive for the current tier'''. If the '''end''' parameter is '''-1''', then we have no limit for the tier.

::; pricePerIncrement - ''float''
::: Price per an increment to be charged.

::; increment - ''float''
::: usage increment size to be charged pricePerIncrement price.

::; includedPrice - ''float''
::: Fixed amount to be payied in a given tier.

== Examples ==

=== Get usage tiers for a given service specification of a product ===
'''Request'''

<nowiki>
GET http://127.0.0.1:6543/productSpecifications/core.plan.linux.webstart/offerings/USD-1/prices?filterRelatedservicespecification=/serviceSpecifications/core.email.openxchange.xmail&filterType=usage_fee
</nowiki>

'''Response'''

'''HTTP/1.0 200 OK'''
<nowiki>
{
"list" : [ {
"name" : "mfg_mailbox_standard",
"billingPeriod" : 1,
"rates" : [ {
"start" : 1.0,
"end" : 3.0,
"pricePerIncrement" : 1.0
"includedPrice": 0.0,
"increment": 1.0
}, {
"start" : 3.0,
"end" : -1.0,
"pricePerIncrement" : 1.0
"includedPrice": 3.0,
"increment": 1.0
} ],
"relatedServiceSpecification" : "http://127.0.0.1:6543/serviceSpecifications/core.email.openxchange.xmail",
"type" : "usage_fee",
"unit" : "mfg_mailbox_standard"
}, {
"name" : "mfg_mailbox_activesync",
"billingPeriod" : 1,
"rates" : [ {
"start" : 1.0,
"end" : -1.0,
"pricePerIncrement" : 2.0
"includedPrice": 0.0,
"increment": 1.0
} ],
"relatedServiceSpecification" : "http://127.0.0.1:6543/serviceSpecifications/core.email.openxchange.xmail",
"type" : "usage_fee",
"unit" : "mfg_mailbox_activesync"
}, {
"name" : "mfg_mailbox_premium",
"billingPeriod" : 1,
"rates" : [ {
"start" : 1.0,
"end" : -1.0,
"pricePerIncrement" : 3.0
"includedPrice": 0.0,
"increment": 1.0
} ],
"relatedServiceSpecification" : "http://127.0.0.1:6543/serviceSpecifications/core.email.openxchange.xmail",
"type" : "usage_fee",
"unit" : "mfg_mailbox_premium"
} ],
"links" : [ {
"href" : "http://127.0.0.1:6543/productspecifications/core.plan.linux.webstart/offerings/USD-1/prices?filterRelatedservicespecification=/serviceSpecifications/core.email.openxchange.xmail&filterType=usage_fee",
"rel" : "self"
} ]
} </nowiki>

=== Get usage tiers for a given service specification of a product filtered by an usage rate's name ===
'''Request'''

<nowiki>
http://127.0.0.1:6543/productSpecifications/core.plan.linux.webstart/offerings/USD-1/prices?filterRelatedservicespecification=/serviceSpecifications/core.email.openxchange.xmail&filterType=usage_fee&filterName=mfg_mailbox_standard
</nowiki>

'''Response'''

'''HTTP/1.0 200 OK'''
<nowiki>
{
"list" : [ {
"name" : "mfg_mailbox_standard",
"billingPeriod" : 1,
"rates" : [ {
"start" : 1.0,
"end" : 3.0,
"pricePerIncrement" : 0.0
"includedPrice": 0.0,
"increment": 1.0
}, {
"start" : 3.0,
"end" : -1.0,
"pricePerIncrement" : 1.0
"includedPrice": 3.0,
"increment": 1.0
} ],
"relatedServiceSpecification" : "http://127.0.0.1:6543/serviceSpecifications/core.email.openxchange.xmail",
"type" : "usage_fee",
"unit" : "mfg_mailbox_standard"
} ],
"links" : [ {
"href" : "http://127.0.0.1:6543/productspecifications/core.plan.linux.webstart/offerings/USD-1/prices?filterRelatedservicespecification=/serviceSpecifications/core.email.openxchange.xmail&filterType=usage_fee&filterName=mfg_mailbox_standard",
"rel" : "self"
} ]
} </nowiki>

== See also ==
* [[Products|Product Catalog API]]
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Product Catalog API]]

Accounts-account-email-domain-webmailUpgrade:GET

2016-05-16T17:27:27Z

Jerry.dimitrov: /* Response */

= GET /accounts/{account}/email/{domain}/webmailUpgrade =
Retrieves the product level upgrade configuration

'''Note:''' /email/{domain}/webmailUpgrade is a shortcut equivalent of this resource
__TOC__

== Request ==
<code>GET /accounts/{account}/email/{domain}/webmailUpgrade</code>

=== URI Parameters ===
; account - ''string''
: Account number for the owner of the email domain entity.
; domain - ''string''
: Target domain name of the email domain resource.

=== Request Headers ===
{{Authorization}}

; Content-Type
: Required. Set this header to <code>application/json; charset=UTF-8</code>

== Response ==
Returns dictionary which contains the webmail upgrade settings for the target domain as a key-value pairs.

=== Status Code ===
; 200 OK
: Success

=== Response Body ===
<nowiki>
{
"allowed": false,
"links": [
{
"href": "https://api.hostway.com/accounts/accNum123/email/example.com/webmailUpgrade/",
"rel": "self"
}
]
}
</nowiki>

==== Parameters ====
; allowed - ''boolean''
: Whether upgrades are enabled or disabled by the product

; links - ''list''
: [[Hypermedia]] for the resource.

== See also ==
* [[Email API|Email API]]
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Email API]]

Accounts-account-email-domain-usernames:GET

2016-05-09T14:01:58Z

Jerry.dimitrov: /* Parameters */

= GET /accounts/{account}/email/{domain}/usernames =
Retrieves a list of mailboxes for a specific account and domain
__TOC__

== Request ==
<code>GET /accounts/{account}/email/{domain}/usernames</code>

==== Request Parameters ====
; account - ''string''
: The user account owning the domain and the mailboxes
; domain - ''string''
: The specific domain for which the call will retrieve the list

=== URI Parameters ===

; filterUsername - ''string''
: Only mailboxes with username matching the value of the parameter will be returned. The values used could be specified as a partial match with a wildcard(*).

; page - ''integer''
: Specifies which page should be displayed. Requires a pageSize parameter to also be provided

; pageSize - ''integer''
: Specifies the number of entries to be displayed on a page. Requires a page parameter to also be provided

; sortField - ''string''
: Specifies if the resulting list is to be sorted by a given field. Allowed values are '''username''' and '''quota'''

; sortOrder - ''string''
: The order in which the sorting is to be done. Allowed values are '''asc''' and '''desc'''

; details - ''integer''
: If set to '''1''' the type of mailbox users will be displayed for each mailbox

== Response ==

=== Status Code ===
; 200 OK
: Success

; 401 Unauthorized
: The supplied credentials are invalid or do not provide permissions for this operation.

; 404 Not Found
: The domain name or account does not exist.

=== Response Body ===
<nowiki>
{
"totalCount": "{count}",
"list": [
{
"username": "{username}",
"webmailAccess": "{webmailAccess}",
"links": [
{
"href": "{href}",
"rel": "{rel}"
}
],
"type": {type},
"quota": {quota},
"master": {master},
"trialType": "{trialType}",
"trialExpiration": "{trialExpiration}",
"allowUpgrade": {allowUpgrade}
}
],

}
</nowiki>

==== Parameters ====
; total count - ''integer''
; The total number of mailboxes under the domain

; username - ''string''
: The username of an individual mailbox

; master - ''integer''
: Allowed values are '''0''' or '''1'''

; quota - ''integer''
: The quota of the mailbox in Megabytes

; webmailAccess - ''string''
: (OPTIONAL)
: The type of webmail of the mailbox. Allowed values can be obtained from the [[Accounts-account-email-domain-webmailNames:GET|webmailNames API endpoint]]. Will only be displayed if the user passed the details URI parameter

; trialType - ''string''
: Trial account type set for a given period of time. Supported values can be obtained from the [[Accounts-account-email-domain-webmailNames:GET|webmailNames API endpoint]].

; trialExpiration - ''date'' - YYYY-mm-dd
: Expiration date of trial period formatted as YYYY-mm-dd.

; href - ''string''
: Link to other resources relevant to the mailboxes lists

; rel - ''string''
: Type of relation to the resource for the provided link

== Examples ==

=== Success scenario ===
'''Request'''
<nowiki>
GET accounts/test-account123/email/test.com/usernames
</nowiki>

'''Response'''
<nowiki>
{
"totalCount": 1,
"list": [
{
"username": "test",
"links": [
{
"href": "{{APIBaseURL}}/accounts/test-account123/email/test.com/usernames/test/mailbox/",
"rel": "self"
}
],
"type": "imap"
"quota": 10,
"master": false,
"trialType": "premium",
"trialExpiration": "2018-10-28",
"allowUpgrade": true
}
]
}
</nowiki>

=== Request with webmailAccess ===
'''Request'''
<nowiki>
GET accounts/test-account123/email/test.com/usernames?details=1
</nowiki>

'''Response'''
<nowiki>
{
"totalCount": 1,
"list": [
{
"username": "test",
"webmailAccess": "standard",
"links": [
{
"href": "{{APIBaseURL}}/accounts/test-account123/email/test.com/usernames/test/mailbox/",
"rel": "self"
}
],
"type": "imap"
"quota": 10,
"master": false,
"trialType": "premium",
"trialExpiration": "2018-10-28",
"allowUpgrade": true
}
]
}
</nowiki>

=== Paginated request with sort order ===
'''Request'''
<nowiki>
GET accounts/test-account123/email/test.com/usernames?page=2&pageSize=2&sortField=username&sortOrder=desc
</nowiki>

'''Response'''
<nowiki>
{
"totalCount": 6,
"list": [
{
"username": "test2",
"links": [
{
"href": "{{APIBaseURL}}/accounts/test-account123/email/test.com/usernames/test2/mailbox/",
"rel": "self"
}
],
"type": "imap",
"quota": 10,
"master": true,
"trialType": "premium",
"trialExpiration": "2018-10-28",
"allowUpgrade": true
},
{
"username": "test1",
"links": [
{
"href": "{{APIBaseURL}}/accounts/test-account123/email/test.com/usernames/test1/mailbox/",
"rel": "self"
}
],
"type": "imap",
"quota": 10,
"master": false,
"trialType": "premium",
"trialExpiration": "2018-10-28",
"allowUpgrade": true
}
],
"links": [
{
"href": "{{APIBaseURL}}/accounts/test-account123/email/test.com/usernames?page=1&pageSize=2",
"rel": "first"
},
{
"href": "{{APIBaseURL}}/accounts/test-account123/email/test.com/usernames?page=1&pageSize=2",
"rel": "previous"
},
{
"href": "{{APIBaseURL}}/accounts/test-account123/email/test.com/usernames?page=3&pageSize=2",
"rel": "next"
},
{
"href": "{{APIBaseURL}}/accounts/test-account123/email/test.com/usernames?page=3&pageSize=2",
"rel": "last"
},
{
"href": "{{APIBaseURL}}/accounts/test-account123/email/test.com/usernames?page=2&pageSize=2",
"rel": "self"
}
]
}
</nowiki>

== See also ==
* [[Email API|Email API]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Email API]]

Accounts-account-email-domain-webmail:GET

2016-05-09T13:59:16Z

Jerry.dimitrov: /* Parameters */

= GET /accounts/{account}/email/{domain}/webmail =
Gets OpenXchange account type for the domain.

__TOC__

== Request ==
<code>GET /accounts/{account}/email/{domain}/webmail</code>

=== URI Parameters ===
; account - ''string''
:
; domain - ''string''
:

=== Request Headers ===
{{Authorization}}

; Content-Type
: Required. Set this header to <code>application/json; charset=UTF-8</code>

== Response ==

=== Status Code ===
; 200 OK
: Success

; 401 Unauthorized
: The supplied credentials are invalid or do not provide permissions for this operation.

; 404 Not Found
: The domain name does not exist.

=== Response Body ===
<nowiki>
{
"type": "{type}",
"allowUpgrade": {allowUpgrade}
"trialType": "{trialType}",
"trialExpiration": "{trialExpiration}",
"links": [
{
"location": "{APIBaseURL}/accounts/{account}/email/{domain}/webmail/",
"rel": "self"
}
]
}
</nowiki>

==== Parameters ====
; type - ''string''
: Webmail account type. Supported values can be obtained from the [[Accounts-account-email-domain-webmailNames:GET|webmailNames API endpoint]].

; allowUpgrade - ''boolean''
: Webmail allowUpgrade option value.

; trialType - ''string'' - Can be null
: Trial account type. Null if not set. Supported values can be obtained from the [[Accounts-account-email-domain-webmailNames:GET|webmailNames API endpoint]].

; trialExpiration - ''date''
: Expiration date of trial period formatted as YYYY-mm-dd. Null if not set.

== Examples ==

=== Success getting account type ===
'''Request'''
<nowiki>
GET /accounts/test/email/test.com/webmail
</nowiki>

'''Response'''
<nowiki>
200 OK

{
"type": "standard",
"allowUpgrade": true,
"trialType": "premium",
"trialExpiration": "2018-10-28",
"links": [
{
"location": "{APIBaseURL}/accounts/{account}/email/{domain}/webmail/",
"rel": "self"
}
]
}
</nowiki>

{{disqus}}
[[Category:Hostway API]]
[[Category:Email API]]

Accounts-account-email-domain-usernames-mailboxName-webmail:GET

2016-05-09T13:46:42Z

Jerry.dimitrov: /* Parameters */

= GET /accounts/{account}/email/{domain}/usernames/{mailboxName}/webmail =
Gets OpenXchange account type.

__TOC__

== Request ==
<code>GET /accounts/{account}/email/{domain}/usernames/{mailboxName}/webmail</code>

=== URI Parameters ===
; account - ''string''
:
; domain - ''string''
:
; mailboxName - ''string''
:

=== Request Headers ===
{{Authorization}}

; Content-Type
: Required. Set this header to <code>application/json; charset=UTF-8</code>

== Response ==

=== Status Code ===
; 200 OK
: Success

; 401 Unauthorized
: The supplied credentials are invalid or do not provide permissions for this operation.

; 404 Not Found
: The domain name does not exist.

=== Response Body ===
<nowiki>
{
"authToken": "{authenticationToken}",
"type": "{type}",
"allowUpgrade": {allowUpgrade},
"resetPassword": {resetPassword},
"theme": "{theme}",
"language": "{language}",
"timezone": "{timezone}",
"links": [
{
"location": "{APIBaseURL}/accounts/{account}/email/{domain}/usernames/{mailboxName}/webmail/",
"rel": "self"
}
]
}
</nowiki>

==== Parameters ====
; authenticationToken - ''string''
: Authentication token value
; allowUpgrade - ''boolean''
: OpenXchange allowUpgrade option
; type - ''string''
: OpenXchange account type. Supported values can be obtained from the [[Accounts-account-email-domain-webmailNames:GET|webmailNames API endpoint]].
; resetPassword - ''boolean''
: Returns if customer will be forced to reset mailbox password the next time he logs in to his OX account
; theme - ''string''
: Theme identifier for setting a specific theme when creating an OX account
; language - ''string''
: OpenXchange account locale of type 'en_US'.
; timezone - ''string''
: OpenXchange account timezone of type 'America/Chicago'.

== Examples ==

=== Success getting account type ===
'''Request'''
<nowiki>
GET /accounts/test/email/test.com/usernames/john.smith/webmail
</nowiki>

'''Response'''
<nowiki>
200 OK

{
"authToken": "PoiC9iyBehe13ZHWyhfa2eArKUJy+RJ5WpyN0eCBs2+Ns8SIdvhgto9zWLDnGZWlgTV9MuJ1F+//XnoKZWxjaRr2qh++437fChyxZmaHwe7g==",
"type": "standard",
"allowUpgrade": true,
"resetPassword": false,
"theme": "test_theme",
"language": "en_US",
"timezone": "America/Chicago",
"links": [
{
"href": "{APIBaseURL}/accounts/test/email/test.com/usernames/john.smith/webmail/",
"rel": "self"
}
]
}
</nowiki>

{{disqus}}
[[Category:Hostway API]]
[[Category:Email API]]

Email-domain-usernames-mailboxName-webmail:POST

2016-05-09T13:40:05Z

Jerry.dimitrov: /* Parameters */

= POST /email/{domain}/usernames/{mailboxName}/webmail =
Creates OpenXchange account.

__TOC__

== Request ==
<code>POST /email/{domain}/usernames/{mailboxName}/webmail</code>

=== URI Parameters ===
; domain - ''string''
:
; mailboxName - ''string''
:

=== Request Headers ===
{{EmailApiAuthorization}}

; Content-Type
: Required. Set this header to <code>application/json; charset=UTF-8</code>

=== Request Body ===
<nowiki>
{
"type": "{oxtype}",
"allowUpgrade": {allowUpgrade},
"theme": "{theme}",
"language": "{language}",
"timezone": "{timezone}"
}
</nowiki>

==== Parameters ====
; allowUpgrade - ''boolean''
: OpenXchange allowUpgrade option value. The default value is true.
; type - ''string''
: OpenXchange account type. Supported values can be obtained from the [[Accounts-account-email-domain-webmailNames:GET|webmailNames API endpoint]]. If not provided - standard is default.
: If current mailbox qty is more than allowed for specific OpenXchange account type the response is ''400 Bad Request''
; theme - ''string''
: Theme identifier for setting a specific theme when creating an OX account. If not provided , default theme is set.
; language - ''string''
: OpenXchange account locale of type 'en_US'.
; timezone - ''string''
: OpenXchange account timezone of type 'America/Chicago'.

== Response ==

=== Status Code ===
; 201 Created
: Success

; 400 Bad Request
: The format of the request body is invalid or the OpenXchange account type does not meet the requirements.

; 401 Unauthorized
: The supplied credentials are invalid or do not provide permissions for this operation.

; 409 Conflict
: OpenXchange account already exists.

; 404 Not Found
: The domain name or mailbox do not exist.

== Examples ==

=== Failure creating account with not-valid parameter ===
'''Request'''
<nowiki>
POST /email/test.com/usernames/john.smith/webmail

{"type": "non-valid"}
</nowiki>

'''Response'''
<nowiki>
400 Bad Request

{"type": "\"non-existing\" is not one of standard, activesync, premium"}
</nowiki>

=== Failure creating account when mailbox qty for OX type is exceeded ===
'''Request'''
<nowiki>
POST /email/test.com/usernames/john.smith/webmail

{"type": "activesync"}
</nowiki>

'''Response'''
<nowiki>
400 Bad Request

{"computeFault":"Number of mailboxes exceeded"}
</nowiki>

=== Success creating account ===
'''Request'''
<nowiki>
POST /email/test.com/usernames/john.smith/webmail

{"type": "activesync", "allowUpgrade": false, "language": "en_US", "timezone": "America/Chicago"}
</nowiki>

'''Response'''
<nowiki>
201 Created
</nowiki>

{{disqus}}
[[Category:Hostway API]]
[[Category:Email API]]

Accounts-account-email-domain-usernames-mailboxName-webmail:POST

2016-05-09T13:35:45Z

Jerry.dimitrov: /* Parameters */

= POST /accounts/{account}/email/{domain}/usernames/{mailboxName}/webmail =
Creates OpenXchange account.

__TOC__

== Request ==
<code>POST /accounts/{account}/email/{domain}/usernames/{mailboxName}/webmail</code>

=== URI Parameters ===
; account - ''string''
:
; domain - ''string''
:
; mailboxName - ''string''
:

=== Request Headers ===
{{Authorization}}

; Content-Type
: Required. Set this header to <code>application/json; charset=UTF-8</code>

=== Request Body ===
<nowiki>
{
"type": "{type}",
"allowUpgrade": {allowUpgrade},
"theme": "{theme}",
"language": "{language}",
"timezone": "{timezone}"
}
</nowiki>

==== Parameters ====
; allowUpgrade - ''boolean''
: OpenXchange allowUpgrade option value. The default value is true.
; type - ''string''
: OpenXchange account type. Supported values can be obtained from the [[Accounts-account-email-domain-webmailNames:GET|webmailNames API endpoint]]. If not provided - standard is default.
: If current mailbox qty is more than allowed for specific OpenXchange account type - the response is ''400 Bad Request''
; theme - ''string''
: Theme identifier for setting a specific theme when creating an OX account. If not provided, default theme is set.
; language - ''string''
: OpenXchange account locale of type 'en_US'.
; timezone - ''string''
: OpenXchange account timezone of type 'America/Chicago'.

== Response ==

=== Status Code ===
; 201 Created
: Success

; 400 Bad Request
: The format of the request body is invalid or the OpenXchange account type does not meet the requirements.

; 401 Unauthorized
: The supplied credentials are invalid or do not provide permissions for this operation.

; 409 Conflict
: OpenXchange account already exists.

; 404 Not Found
: The domain name or mailbox do not exist.

== Examples ==

=== Failure creating account with not-valid parameter ===
'''Request'''
<nowiki>
POST /accounts/test/email/test.com/usernames/john.smith/webmail

{"type": "non-valid"}
</nowiki>

'''Response'''
<nowiki>
400 Bad Request

{"type": "\"non-existing\" is not one of standard, activesync, premium"}
</nowiki>

=== Failure creating account when mailbox qty for OX type is exceeded ===
'''Request'''
<nowiki>
POST /accounts/test/email/test.com/usernames/john.smith/webmail

{"type": "activesync"}
</nowiki>

'''Response'''
<nowiki>
400 Bad Request

{"computeFault":"Number of mailboxes exceeded"}
</nowiki>

=== Success creating account ===
'''Request'''
<nowiki>
POST /accounts/test/email/test.com/usernames/john.smith/webmail

{"type": "standard", "allowUpgrade": false, "language": "en_US", "timezone": "America/Chicago"}
</nowiki>

'''Response'''
<nowiki>
201 Created
</nowiki>

{{disqus}}
[[Category:Hostway API]]
[[Category:Email API]]

Accounts-account-email-domain-usernames-mailboxName-mailbox:PUT

2016-05-09T13:33:20Z

Jerry.dimitrov: /* Parameters */

= PUT accounts/{account}/email/{domain}/usernames/{mailboxName}/mailbox =
Creates or updates a mailbox for specified account and domain. The mailbox quota is determined by the E-mail domain product specification.
__TOC__

== Request ==
<code>PUT accounts/{account}/email/{domain}/usernames/{mailboxName}/mailbox</code>

=== URI Parameters ===
; account - ''string''
:
; domain - ''string''
:
; mailboxName - ''string''
: The mailbox. String should meet the regexp [a-zA-Z0-9._-]+

=== Request Headers ===
{{Authorization}}

; Content-Type
: Required. Set this header to <code>application/json; charset=UTF-8</code>

=== Request Body ===
<nowiki>
{
"password": "{password}",
"master": {master},
"quota": {quota},
"type": {type},
"username": {username}
}
</nowiki>

==== Parameters ====
<onlyinclude>
; password - ''string'' (Required)
: The password. The password should be at least 8 characters long, a mix of numbers, symbols and mixed-case letters. It should not begin with "pass", "123", "abc", should not contain the second-level domain name of the service, should not contain the username of the mailbox or start with its first 3 characters. There is a restriction using the same password more than once.
: Password validation rules:
:: Password must not be used more than once
:: Minimum length 8
:: Maximum length 128
:: Should have at least one digit
:: Should have at least one capital letter
:: Should have at least one lower case letter
:: Should contain at least one special character (any character other than lower or uppercase letters, digits and underscore "_" is considered special character)
:: Should not start with the phrase 'pass' case-insensitively
:: Should not start with 'abc' case-insensitively
:: Should not start with 123
:: Must not contain second-level domain, username or start with the first 3 letters from the username
</onlyinclude>

; master - ''boolean''
: Describes if this is a master account.

; quota - ''int''
: Quota value in MB. If not provided default quota for OpenXchange type is set

; type - ''string''
: OpenXchange account type. Supported values can be obtained from the [[Accounts-account-email-domain-webmailNames:GET|webmailNames API endpoint]]. If not provided - standard is default.
: If current mailbox qty is more than the allowed value for specific OpenXchange account type, the response will be ''400 Bad Request''

; username - ''string''
: The mailbox. String should meet the regexp [a-zA-Z0-9._-]+
: Should be used when updating mailbox only

== Response ==

=== Status Code ===
; 201 Created
: Success

; 204 No Content
: Success

; 400 Bad Request
: The format of the request body is invalid or the username does not meet the requirements.

; 401 Unauthorized
: The supplied credentials are invalid or do not provide permissions for this operation.

; 404 Not Found
: The domain name does not exist.

; 409 Conflict
: Mailbox already exists.

== Examples ==

=== Trying to create mailbox without a password ===
'''Request'''
<nowiki>
PUT /accounts/test-account123/email/test.com/usernames/john.smith/mailbox

{"master": false}
</nowiki>

'''Response'''
<nowiki>
400 Bad Request

{"password":"Required"}
</nowiki>

=== Trying to create mailbox with a not valid password ===
'''Request'''
<nowiki>
PUT /accounts/test-account123/email/test.com/usernames/john.smith/mailbox

{"password": "abc1234", "master": true}
</nowiki>

'''Response'''
<nowiki>
400 Bad Request

{"password":"Required"}
</nowiki>

=== Trying to create mailbox with invalid quota value(less or equal to 0) ===
'''Request'''
<nowiki>
PUT /accounts/test-account123/email/test.com/usernames/john.smith/mailbox

{"password: "test_password1", "quota": 0}
</nowiki>

'''Response'''
<nowiki>
400 Bad Request

{"computeFault":"Quota must be greater than 0"}
</nowiki>

=== Trying to create mailbox when mailbox qty for OX type is exceeded ===
'''Request'''
<nowiki>
PUT /accounts/test-account123/email/test.com/usernames/john.smith/mailbox

{"password: "test_password1", "type": "activesync"}
</nowiki>

'''Response'''
<nowiki>
400 Bad Request

{"computeFault":"Number of mailboxes exceeded"}
</nowiki>

=== Create mailbox ===
'''Request'''
<nowiki>
PUT /accounts/test-account123/email/test.com/usernames/john.smith/mailbox

{"password": "pWord123$", "master": true}
</nowiki>

'''Response'''
<nowiki>
201 Created
</nowiki>

=== Update mailbox password ===
'''Request'''
<nowiki>
PUT /accounts/test-account123/email/test.com/usernames/john.smith/mailbox

{"password": "!q2w3e4R"}
</nowiki>

'''Response'''
<nowiki>
204 No Content
</nowiki>

=== Trying to update mailbox password with already used one ===
'''Request'''
<nowiki>
PUT /accounts/test-account123/email/test.com/usernames/john.smith2/mailbox

{"password": "pWord123$"}
</nowiki>

'''Response'''
<nowiki>
400 Bad Request
</nowiki>

=== Update mailbox name ===
'''Request'''
<nowiki>
PUT /accounts/test-account123/email/test.com/usernames/john.smith/mailbox

{"username": "john.smith2"}
</nowiki>

'''Response'''
<nowiki>
204 No Content
</nowiki>

=== Update mailbox using an existing name ===
'''Request'''
<nowiki>
PUT /accounts/test-account123/email/test.com/usernames/john.smith/mailbox

{"username": "jack.smith"}
</nowiki>

'''Response'''
<nowiki>
400 Bad Request
</nowiki>

=== Create mailbox with specified quota===
'''Request'''
<nowiki>
PUT /accounts/test-account123/email/test.com/usernames/john.smith2/mailbox

{"password": "pword1234", "quota": 70}
</nowiki>

'''Response'''
<nowiki>
201 Created
</nowiki>

=== Update existing mailbox quota===
'''Request'''
<nowiki>
PUT /accounts/test-account123/email/test.com/usernames/john.smith2/mailbox

{"quota": 85}
</nowiki>

'''Response'''
<nowiki>
204 No Content
</nowiki>

== See also ==
* [[Email API|Email API]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Email API]]

Webmailnames:GET

2016-05-09T13:22:50Z

Jerry.dimitrov: /* Response */

= GET /webmailnames =
Retrieves WebMail plan names mapping.
__TOC__

== Request ==
<code>GET /webmailnames</code>

==== Request Parameters ====
None.

=== URI Parameters ===
None.

== Response ==
Returns a dictionary containing the full list of available OpenXchange types by text key and WebMail plan names.

=== Status Code ===
;200 OK
: Success

=== Response Body ===
<nowiki>
{
"webmailNames": {
"activesync": "SMX Sync Advanced",
"premium": "SMA Collaborate Premium",
"standard": "SMX Mail Basic"
},
"links": [
{
"href": "https://api.hostway.com/webmailnames/",
"rel": "self"
}
]
}
</nowiki>

==== Parameters ====
; webmailNames - ''dictionary''
: Dictionary containing WebMail plan names mapping

; links - ''list''
: [[Hypermedia]] for this resource.

== See also ==
* [[Miscellaneous|Miscellaneous APIs]]
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Miscellaneous APIs]]

Accounts-account-email-domain-webmailNames:GET

2016-05-09T13:18:51Z

Jerry.dimitrov: /* Response */

= GET /accounts/{account}/email/{domain}/webmailNames =
Retrieves mapping of the allowed OX types with WebMail plan names for the target email domain resource. The result can be tied to a specific plan configuration on the product level.

'''Note:''' /email/{domain}/webmailNames is a shortcut equivalent of this resource
__TOC__

== Request ==
<code>GET /accounts/{account}/email/{domain}/webmailNames</code>

=== URI Parameters ===
; account - ''string''
: Account number for the owner of the email domain entity.
; domain - ''string''
: Target domain name of the email domain resource.

=== Request Headers ===
{{Authorization}}

; Content-Type
: Required. Set this header to <code>application/json; charset=UTF-8</code>

== Response ==
Returns dictionary which contains the mapping of supported OpenXchange types by text key and WebMail plan names for the specific email domain resource.

=== Status Code ===
; 200 OK
: Success

=== Response Body ===
<nowiki>
{
"webmailNames": {
"activesync": "SMX Sync Advanced",
"premium": "SMA Collaborate Premium",
"standard": "SMX Mail Basic"
},
"links": [
{
"href": "https://api.hostway.com/accounts/accNum123/email/example.com/webmailNames/",
"rel": "self"
}
]
}
</nowiki>

==== Parameters ====
; webmailNames - ''dictionary''
: Dictionary containing the supported OX types by text key and the WebMail plan names.

; links - ''list''
: [[Hypermedia]] for the resource.

== See also ==
* [[Email API|Email API]]
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Email API]]

Accounts-account-dedicatedServers-server:GET

2016-04-08T16:26:59Z

Jerry.dimitrov: /* Parameters */

= GET /accounts/{accountId}/dedicatedServers/{serverId} =
Retrieves specified dedicated server info.

__TOC__

== Request ==
<code>GET /accounts/''{accountId}''/dedicatedServers/''{serverId}''</code>

==== Request Parameters ====
; accountId - ''string''
: The user account owning the dedicated server
; serverId - ''string''
: The specified dedicated server Id

=== Request Headers ===

{{Authorization}}

== Response ==

=== Response Body ===
<nowiki>
{
"dedicatedServerId": "{serverId}",
"serverName": "{serverName}",
"pdu": "{pduInfo}",
"ipAddresses": [
{
"href": "{APIBaseURL}/accounts/{accountId}/dedicatedServers/{serverId}/ipAddresses",
"rel": "related"
}
],
"links": [
{
"href": "{APIBaseURL}/accounts/{accountId}/dedicatedServers/{serverId}/",
"rel": "self"
}
]
}
</nowiki>

==== Parameters ====
; dedicatedServerId - ''string''
: The Id of the dedicated server

; serverName - ''string''
: The name of the dedicated server

; pduInfo - ''string(optional)''
: A comma-separated list of PDU interfaces used for the server's remote-reboot. If the PDU is not configured, the field is omitted.

; ipAddresses - ''list''
: Links to IP addresses for this dedicated server

; links - ''list''
: [[Hypermedia]] for this resource. Link to self will preserve sorting and pagination set by the request. Links to the first, last, previous and next pages will also be included if applicable

=== Expected Response Codes ===
; 200 OK
: Success

; 401 Unauthorized
: The supplied credentials are invalid.

; 403 Forbidden
: The authorized user does not have permissions to access the resource. The only user(s) who has access to the dedicated servers list must be a sales agent, the account owner, or the account technical admin.

; 404 Not Found
: The account or server does not exist.

== Examples ==

=== Get specific dedicated server info ===
'''Request'''
<nowiki>
GET accounts/test-account123/dedicatedServers/test-srv-00132ff1
</nowiki>

'''Response'''
<nowiki>
{
"dedicatedServerId": "test-srv-00132ff1",
"serverName": "Server10",
"ipAddresses": [
{
"href": "{APIBaseURL}/accounts/test-account123/dedicatedServers/test-srv-00132ff1/ipAddresses",
"rel": "related"
}
],
"links": [
{
"href": "{APIBaseURL}/accounts/test-account123/dedicatedServers/test-srv-00132ff1/",
"rel": "self"
}
]
}
</nowiki>

== See also ==
* [[Dedicated_Server_API|Dedicated Server API]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Dedicated Server API]]

ServiceAttributes-core.fax.number

2016-03-22T15:25:31Z

Jerry.dimitrov: /* Attributes Body */

= Fax Over Email Number Attributes =
Attributes used for the FOE fax number.
__TOC__

== Attributes Body ==
<nowiki>
{
"areaCode": "{area_code}",
"name": "{name}"
}
</nowiki>

==== Parameters ====
; areaCode - ''string''
: ''(REQUIRED)''
: Standard 3 digit US [https://en.wikipedia.org/wiki/Telephone_numbering_plan area code] (e.g. ''312'', ''412'').
: Represents one of the supported area codes for a fax number within a particular ZIP area.
: Please refer to the [[Faxoveremail-zipCodes-zipCode-areaCodes:GET|FOE Supported Area Codes by ZIP code API]] page for a detailed information about the supported area codes.

; name - ''string''
: Customer friendly name/label for the fax number.

== See also ==
* [[Faxoveremail-zipCodes-zipCode-areaCodes:GET|Supported Area Codes by ZIP code]]
* [[ServiceAttributesStructure|Service Attributes Structure]]
* [[Orders|Orders API]]
* [[Account|Account Management API]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Ordering API]]
[[Category:Account Management API]]

Faxoveremail-zipCodes-zipCode-areaCodes:GET

2016-03-22T14:19:51Z

Jerry.dimitrov: /* Parameters */

= GET /faxOverEmail/zipCodes/{zipCode}/areaCodes =
Get list of supported FOE area codes for a given zip code.
__TOC__

== Request ==
<code>GET /faxOverEmail/zipCodes/{zipCode}/areaCodes</code>

==== Request Parameters ====
; zipCode - ''string''
: US standard [https://en.wikipedia.org/wiki/ZIP_code ZIP code] - both '''ZIP code 5''' and '''ZIP code 5 plus 4''' formats are supported (e.g. ''98001'', ''98001-9000'').

=== URI Parameters ===
None.

== Response ==

=== Status Code ===
;200 OK
: Success

;304 Not Modified
: The list of area codes hasn't changed since the last request; the client should use its locally cached copy instead.

=== Response Body ===
<nowiki>
{
"list": [
"{areaCode}",
...
],
"links": [
"self": {"href": "</nowiki>{{APIBaseURL}}<nowiki>/faxOverEmail/zipCodes/{zipCode}/areaCodes", "rel": "self"}
]
}
</nowiki>

=== Parameters ===
; areaCode - ''string''
: Standard 3 digit US [https://en.wikipedia.org/wiki/Telephone_numbering_plan area code] (e.g. ''312'', ''412'').

; links - ''list''
: [[Hypermedia]] for this resource. Links to self.

== See also ==
* [[Miscellaneous|Miscellaneous APIs]]
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Miscellaneous APIs]]

ServiceAttributes-core.fax.user

2016-03-22T14:05:45Z

Jerry.dimitrov: Created page with "= Fax Over Email User Attributes = Attributes used for the FOE user. __TOC__ == Attributes Body == <nowiki> { "zipCode": "{zip_code}", } </nowiki> ==== Parameters ==== ;..."

= Fax Over Email User Attributes =
Attributes used for the FOE user.
__TOC__

== Attributes Body ==
<nowiki>
{
"zipCode": "{zip_code}",
}
</nowiki>

==== Parameters ====
; zipCode - ''string''
: ''(REQUIRED)''
: US standard [https://en.wikipedia.org/wiki/ZIP_code ZIP code] - both '''ZIP code 5''' and '''ZIP code 5 plus 4''' formats are supported (e.g. ''98001'', ''98001-9000'').
: Represents the zip code of the user.

== See also ==
* [[ServiceAttributesStructure|Service Attributes Structure]]
* [[Orders|Orders API]]
* [[Account|Account Management API]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Ordering API]]
[[Category:Account Management API]]

Miscellaneous

2016-03-22T12:10:00Z

Jerry.dimitrov: /* FaxOverEmail supported Area Codes by Zip Code */

= Miscellaneous APIs =
__TOC__
[{{fullurl:{{FULLPAGENAMEE}}|action=pdfbook}} download this selection of articles as a PDF book]

== Geographical Locations ==
* [[Countries:GET|GET /countries]] - Returns list of all supported countries
* [[Countries-countryCode-provinces:GET|GET /countries/{countryCode}/provinces]] - Returns list of supported provinces or

== Supported Salutations ==
* [[Salutations:GET|GET /salutations]] - Returns list of supported salutations

== Supported User Roles ==
* [[Roles:GET|GET /roles]] - Returns list of supported user roles

== FaxOverEmail supported Area Codes by Zip Code ==
* [[Faxoveremail-zipCodes-zipCode-areaCodes:GET|GET /faxOverEmail/zipCodes/{zipCode}/areaCodes]] - Returns list of area codes by a given zip code that FOE supports

== Email Validation ==
* [[Email Validation:POST|POST /validations/email]] - Validates a registered email

== Heartbeat ==
* [[heartbeat:GET|GET /heartbeat]] - Get heartbeat

== WebMail Plan Names ==
* [[webmailnames:GET|GET /webmailnames]] - Get WebMail plan names

== See also ==
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Miscellaneous APIs]]

ServiceAttributes-core.sharepoint2007

2016-03-21T16:29:43Z

Jerry.dimitrov: /* Parameters */

= SharePoint 2007 Attributes =
Attributes used when configuring the SharePoint 2007.
__TOC__

== Attributes Body ==
<nowiki>
{
"domain": "{domain}",
"is_shared": 0|1,
"name": "{name}",
"template_key": "{template_key}"
}
</nowiki>

==== Parameters ====
; domain - ''String''
: ''(REQUIRED)''
: The domain name for the SharePoint product.

; is_shared - ''Integer''
: ''(REQUIRED)''
: Flag that specifies whether the domain attribute is shared domain or not. Possible values are '''1''' or '''0''' (a.k.a true or false).

; name - ''String''
: ''(REQUIRED)''
: Sub domain name which will be the prefix of the actual [https://en.wikipedia.org/wiki/Fully_qualified_domain_name FQDN] for the SharePoint portal resource.

; template_key - ''String''
: ''(OPTIONAL)''
: Specific template text key for the SharePoint resource.

== See also ==
* [[ServiceAttributesStructure|Service Attributes Structure]]
* [[Orders|Orders API]]
* [[Account|Account Management API]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Ordering API]]
[[Category:Account Management API]]

Dns-zone:GET

2015-11-16T16:05:24Z

Jerry.dimitrov: /* Response */

= GET /dns/''{zone}'' =
Returns the details of a DNS zone.
__TOC__
== Request ==
<code>GET /dns/''{zone}''</code>

==== Parameters ====
; zone - ''string''
: The name of the DNS zone.

=== Request Headers ===
; Authorization
: Base64-encoded username:password string

== Response ==

=== Status Code ===
;200 OK
: Success

;401 Unauthorized
: The server could not verify the credentials from the authorization header.

;403 Forbidden
: The server denies the access to the resource.

;404 Not Found
: The specified zone does not exist.

=== Response Body ===
<nowiki>
{
"minimumTTL": {minimumTTL},
"retry": {retry},
"name": "{zone}",
"primaryNS": "{primaryNS}",
"refresh": {refresh},
"expire": {expire},
"emailAddress": "{emailAddress}",
"ttl": {ttl},
"serial": {serial},
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/dns/{zone}", "rel": "self"},
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/dns/{zone}/records", "rel": "related"}
]
}
</nowiki>

== Examples ==
''Request:''
<nowiki>
GET /dns/test.com
</nowiki>

''Response:''
<nowiki>
401 Unauthorized
</nowiki>

''Request:''
<nowiki>
GET /dns/unknown-zone.com
Authorization: Basic {base64_encoded(username:password)}
</nowiki>

''Response:''
<nowiki>
403 Forbidden

{
"forbidden": {"message": "Unauthorized: Dns failed permission check", "code": 403, "details": ""}
}
</nowiki>

''Request:''
<nowiki>
GET /dns/test.com
Authorization: Basic {base64_encoded(username:password)}
</nowiki>

''Response:''
<nowiki>
200 OK

{
"minimumTTL": 300,
"retry": 7200,
"name": "test.com.",
"links": [
{"href": "http://127.0.0.1/dns/test.com/", "rel": "self"},
{"href": "http://127.0.0.1/dns/test.com/records", "rel": "related"}
],
"primaryNS": "a.dns.hostway.net.",
"refresh": 28800,
"expire": 604800,
"emailAddress": "hostmaster.siteprotect.com.",
"ttl": 14400,
"serial": 1359151749
}
</nowiki>

== See also ==
* [[DNS|DNS API]]
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:DNS API]]

Accounts-accountId-dedicatedServers-serverId-ipAddresses-ipaddress-statistics-traffic:GET

2015-10-07T13:47:39Z

Jerry.dimitrov: /* URI Parameters */

= GET /accounts/{accountId}/dedicatedServers/{serverId}/ipAddresses/{ipAddress}/statistics/traffic =
Get traffic statistics by specific time range for an IP address of a dedicated server.
__TOC__

=== Request ===
<code>GET /accounts/{accountId}/dedicatedServers/{serverId}/ipAddresses/{ipAddress}/statistics/traffic?scope={scope}&startDate={startDate}&endDate={endDate}&period={period}''&''method={method}</code>

== URI Parameters ==
; accountId - ''string''
: ''(required)''
: The account Id of the dedicated server owner.

; serverId
: ''(required)''
: The dedicated server Id for the requested IP address.

; ipAddress - ''string''
: The specific IP address.

; scope
: ''(required)''
: The scope defines whether we want statistics for inbound or outbound traffic. Possible values: '''receive''' and '''transmit''' and '''total''' (receive plus transmit values).

; startDate
: ''(required)''
: Start date that represents the beginning of the requested statistical time frame. The format should be '''yyyy-mm-dd'''.

; endDate
: ''(required)''
: End date that represents the end of the requested statistical time frame. The format should be '''yyyy-mm-dd'''.

; period
: ''(required)''
: Represents the granularity of the returned data sets for the requested time frame. Possible values: '''hourly''' or '''daily'''.

; method
: ''(required)''
: Statistics method used. Possible values: '''avg''','''sum''','''min''' and '''max'''.

=== Request Headers ===

;: {{Authorization}}
; Accept - HTTP Accept header [http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1]
: Possible values are ''application/json'', ''text/csv''. If omitted json will be returned.

== Date Format ==
: All dates are interpreted and represented in UTC with [http://www.iso.org/iso/home/standards/iso8601.htm ISO 8601 format]

== Response ==
=== Status Codes ===
; 200 OK
: Success

; 400 Bad Request
: Incorrect URI parameters.

; 401 Unauthorized
: The supplied credentials are invalid or do not provide permissions for this operation.

; 403 Forbidden
: The authorized user does not have permissions to access the resource or the requested time frame exceeds the maximum limit for the API.
: The current limit is 500 data sets per response entity, regardless of the period granularity.

; 404 Not Found
: The dedicated server or account does not exist.

=== Response Body ===
<nowiki>
[
{
"count": {count},
"date": "{date}",
"values": {values}
}
]</nowiki>

==== Parameters ====
; count - ''integer''
: The count of traffic operations for the specified period.

; date - ''string''
: The date time stamp for the specified period.

; values - ''float''
: The actual traffic value represented for the specified period.

== Examples ==
'''Successful response for total daily inbound traffic statistics'''
:'''GET''' /accounts/{accountId}/dedicatedServers/{serverId}/ipAddresses/{ipAddress}/statistics/traffic?scope=receive&startDate=2015-05-05&endDate=2012-05-07&period=daily&method=sum

''Response Code:''
<pre>HTTP/1.1 200 OK</pre>

''Response Body:''
<nowiki>
[
{
"count": 143,
"date": "2015-05-05 00:00:00",
"values": 344130.30069930002
},
{
"count": 144,
"date": "2015-05-07 00:00:00",
"values": 658.34027777777999
},
]</nowiki>

'''Failure while trying to get traffic statistics and the number of returned data sets exceeds the maximum limit'''
:'''GET''' /accounts/{accountId}/dedicatedServers/{serverId}/ipAddresses/{ipAddress}/statistics/traffic?scope=receive&startDate=2015-01-01&endDate=2015-05-05&period=daily&method=sum

''Response Code:''
<pre>HTTP/1.1 403 Forbidden</pre>

''Response Body:''
<nowiki>
{
"overLimit": {
"message": "GET data error",
"code": 403,
"details": "The (startDate, endDate) range is too large. Maximum number of returned data sets exceeded."
}
}</nowiki>

'''Failure while trying to get traffic statistics and the start date is before the create date (2015-01-01) of the dedicated server'''
:'''GET''' /accounts/{accountId}/dedicatedServers/{serverId}/ipAddresses/{ipAddress}/statistics/traffic?scope=receive&startDate=2011-01-01&endDate=2015-05-05&period=daily&method=sum

''Response Code:''
<pre>HTTP/1.1 400 Bad Request</pre>

''Response Body:''
<nowiki>
{
"badRequest": {
"message": "GET data error",
"code": 400,
"details": {
"startDate": "2011-01-01 is less than minimum value 2015-01-01"
}
}
}</nowiki>

[[Category:Hostway API]]
[[Category:Dedicated Server API]]

Accounts-accountId-dedicatedServers-serverId-statistics-traffic:GET

2015-10-07T13:46:12Z

Jerry.dimitrov: /* URI Parameters */

= GET /accounts/{accountId}/dedicatedServers/{serverId}/statistics/traffic =
Get traffic statistics by specific time range for a dedicated server.
__TOC__

=== Request ===
<code>GET /accounts/{accountId}/dedicatedServers/{serverId}/statistics/traffic?scope={scope}&startDate={startDate}&endDate={endDate}&period={period}''&''method={method}</code>

== URI Parameters ==
; accountId - ''string''
: ''(required)''
: The account Id of the dedicated server owner.

; serverId
: ''(required)''
: The specified dedicated server Id.

; scope
: ''(required)''
: The scope defines whether we want statistics for inbound or outbound traffic. Possible values: '''receive''', '''transmit''' and '''total''' (receive plus transmit values).

; startDate
: ''(required)''
: Start date that represents the beginning of the requested statistical time frame. The format should be '''yyyy-mm-dd'''.

; endDate
: ''(required)''
: End date that represents the end of the requested statistical time frame. The format should be '''yyyy-mm-dd'''.

; period
: ''(required)''
: Represents the granularity of the returned data sets for the requested time frame. Possible values: '''hourly''' or '''daily'''.

; method
: ''(required)''
: Statistics method used. Possible values: '''avg''','''sum''','''min''' and '''max'''.

=== Request Headers ===

;: {{Authorization}}
; Accept - HTTP Accept header [http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1]
: Possible values are ''application/json'', ''text/csv''. If omitted json will be returned.

== Date Format ==
: All dates are interpreted and represented in UTC with [http://www.iso.org/iso/home/standards/iso8601.htm ISO 8601 format]

== Response ==
=== Status Codes ===
; 200 OK
: Success

; 400 Bad Request
: Incorrect URI parameters.

; 401 Unauthorized
: The supplied credentials are invalid or do not provide permissions for this operation.

; 403 Forbidden
: The authorized user does not have permissions to access the resource or the requested time frame exceeds the maximum limit for the API.
: The current limit is 500 data sets per response entity, regardless of the period granularity.

; 404 Not Found
: The dedicated server or account does not exist.

=== Response Body ===
<nowiki>
[
{
"count": {count},
"date": "{date}",
"values": {values}
}
]</nowiki>

==== Parameters ====
; count - ''integer''
: The count of traffic operations for the specified period.

; date - ''string''
: The date time stamp for the specified period.

; values - ''float''
: The actual traffic value represented for the specified period.

== Examples ==
'''Successful response for total daily inbound traffic statistics'''
:'''GET''' /accounts/{accountId}/dedicatedServers/{serverId}/statistics/traffic?scope=receive&startDate=2015-05-05&endDate=2012-05-07&period=daily&method=sum

''Response Code:''
<pre>HTTP/1.1 200 OK</pre>

''Response Body:''
<nowiki>
[
{
"count": 143,
"date": "2015-05-05 00:00:00",
"values": 344130.30069930002
},
{
"count": 144,
"date": "2015-05-07 00:00:00",
"values": 658.34027777777999
},
]</nowiki>

'''Failure while trying to get traffic statistics and the number of returned data sets exceeds the maximum limit'''
:'''GET''' /accounts/{accountId}/dedicatedServers/{serverId}/statistics/traffic?scope=receive&startDate=2015-01-01&endDate=2015-05-05&period=daily&method=sum

''Response Code:''
<pre>HTTP/1.1 403 Forbidden</pre>

''Response Body:''
<nowiki>
{
"overLimit": {
"message": "GET data error",
"code": 403,
"details": "The (startDate, endDate) range is too large. Maximum number of returned data sets exceeded."
}
}</nowiki>

'''Failure while trying to get traffic statistics and the start date is before the create date (2015-01-01) of the dedicated server'''
:'''GET''' /accounts/{accountId}/dedicatedServers/{serverId}/statistics/traffic?scope=receive&startDate=2011-01-01&endDate=2015-05-05&period=daily&method=sum

''Response Code:''
<pre>HTTP/1.1 400 Bad Request</pre>

''Response Body:''
<nowiki>
{
"badRequest": {
"message": "GET data error",
"code": 400,
"details": {
"startDate": "2011-01-01 is less than minimum value 2015-01-01"
}
}
}</nowiki>

[[Category:Hostway API]]
[[Category:Dedicated Server API]]

Accounts-accountId-dedicatedServers-serverId-ipAddresses-ipaddress-statistics-traffic:GET

2015-09-15T14:53:49Z

Jerry.dimitrov: Created page with "= GET /accounts/{accountId}/dedicatedServers/{serverId}/ipAddresses/{ipAddress}/statistics/traffic = Get traffic statistics by specific time range for an IP address of a dedic..."

= GET /accounts/{accountId}/dedicatedServers/{serverId}/ipAddresses/{ipAddress}/statistics/traffic =
Get traffic statistics by specific time range for an IP address of a dedicated server.
__TOC__

=== Request ===
<code>GET /accounts/{accountId}/dedicatedServers/{serverId}/ipAddresses/{ipAddress}/statistics/traffic?scope={scope}&startDate={startDate}&endDate={endDate}&period={period}''&''method={method}</code>

== URI Parameters ==
; accountId - ''string''
: ''(required)''
: The account Id of the dedicated server owner.

; serverId
: ''(required)''
: The dedicated server Id for the requested IP address.

; ipAddress - ''string''
: The specific IP address.

; scope
: ''(required)''
: The scope defines whether we want statistics for inbound or outbound traffic. Possible values: '''receive''' and '''transmit'''.

; startDate
: ''(required)''
: Start date that represents the beginning of the requested statistical time frame. The format should be '''yyyy-mm-dd'''.

; endDate
: ''(required)''
: End date that represents the end of the requested statistical time frame. The format should be '''yyyy-mm-dd'''.

; period
: ''(required)''
: Represents the granularity of the returned data sets for the requested time frame. Possible values: '''hourly''' or '''daily'''.

; method
: ''(required)''
: Statistics method used. Possible values: '''avg''','''sum''','''min''' and '''max'''.

=== Request Headers ===

;: {{Authorization}}
; Accept - HTTP Accept header [http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1]
: Possible values are ''application/json'', ''text/csv''. If omitted json will be returned.

== Date Format ==
: All dates are interpreted and represented in UTC with [http://www.iso.org/iso/home/standards/iso8601.htm ISO 8601 format]

== Response ==
=== Status Codes ===
; 200 OK
: Success

; 400 Bad Request
: Incorrect URI parameters.

; 401 Unauthorized
: The supplied credentials are invalid or do not provide permissions for this operation.

; 403 Forbidden
: The authorized user does not have permissions to access the resource or the requested time frame exceeds the maximum limit for the API.
: The current limit is 500 data sets per response entity, regardless of the period granularity.

; 404 Not Found
: The dedicated server or account does not exist.

=== Response Body ===
<nowiki>
[
{
"count": {count},
"date": "{date}",
"values": {values}
}
]</nowiki>

==== Parameters ====
; count - ''integer''
: The count of traffic operations for the specified period.

; date - ''string''
: The date time stamp for the specified period.

; values - ''float''
: The actual traffic value represented for the specified period.

== Examples ==
'''Successful response for total daily inbound traffic statistics'''
:'''GET''' /accounts/{accountId}/dedicatedServers/{serverId}/ipAddresses/{ipAddress}/statistics/traffic?scope=receive&startDate=2015-05-05&endDate=2012-05-07&period=daily&method=sum

''Response Code:''
<pre>HTTP/1.1 200 OK</pre>

''Response Body:''
<nowiki>
[
{
"count": 143,
"date": "2015-05-05 00:00:00",
"values": 344130.30069930002
},
{
"count": 144,
"date": "2015-05-07 00:00:00",
"values": 658.34027777777999
},
]</nowiki>

'''Failure while trying to get traffic statistics and the number of returned data sets exceeds the maximum limit'''
:'''GET''' /accounts/{accountId}/dedicatedServers/{serverId}/ipAddresses/{ipAddress}/statistics/traffic?scope=receive&startDate=2015-01-01&endDate=2015-05-05&period=daily&method=sum

''Response Code:''
<pre>HTTP/1.1 403 Forbidden</pre>

''Response Body:''
<nowiki>
{
"overLimit": {
"message": "GET data error",
"code": 403,
"details": "The (startDate, endDate) range is too large. Maximum number of returned data sets exceeded."
}
}</nowiki>

'''Failure while trying to get traffic statistics and the start date is before the create date (2015-01-01) of the dedicated server'''
:'''GET''' /accounts/{accountId}/dedicatedServers/{serverId}/ipAddresses/{ipAddress}/statistics/traffic?scope=receive&startDate=2011-01-01&endDate=2015-05-05&period=daily&method=sum

''Response Code:''
<pre>HTTP/1.1 400 Bad Request</pre>

''Response Body:''
<nowiki>
{
"badRequest": {
"message": "GET data error",
"code": 400,
"details": {
"startDate": "2011-01-01 is less than minimum value 2015-01-01"
}
}
}</nowiki>

[[Category:Hostway API]]
[[Category:Dedicated Server API]]

Dedicated Server API

2015-09-15T14:50:15Z

Jerry.dimitrov: /* Traffic */

== Dedicated Servers ==
* [[Accounts-account-dedicatedServers:GET|GET /accounts/{account_number}/dedicatedServers]] - Gets a list of dedicated servers
* [[Accounts-account-dedicatedServers-server:GET|GET /accounts/{accountId}/dedicatedServers/{serverId}]] - Gets specified dedicated server info
* [[Accounts-account-dedicatedServers-server-ipAddresses:GET|GET /accounts/{accountId}/dedicatedServers/{serverId}/ipAddresses]] - Gets a list of a specified dedicated server's IP addresses
* [[Accounts-account-dedicatedServers-server-ipAddresses-ipaddress:GET|GET /accounts/{accountId}/dedicatedServers/{serverId}/ipAddresses/{ipAddress}]] - Gets a specific IP address of a dedicated server

== Dedicated Server Actions ==
* [[Remote-reboot-dedicatedServer:POST|POST /accounts/{account_number}/dedicatedServers/{server_id}/action]] - Apply actions on a dedicated server e.g. remote reboot

== Monitoring Dedicated Servers ==
[[Monitoring|Monitoring API]] - All monitoring operations with dedicated servers and their services

== Security Groups ==
* [[Accounts-account-dedicatedServers-server-ipAddresses-ipaddress-os-security-groups:GET|GET /accounts/{accountId}/dedicatedServers/{serverId}/ipAddresses/{ipAddress}/os-security-groups]] - Get all security groups, which are assigned to a specific IP address of a dedicated server
* [[Accounts-account-dedicatedServers-server-ipAddresses-ipaddress-os-security-group:PUT|PUT /accounts/{accountId}/dedicatedServers/{serverId}/ipAddresses/{ipAddress}/os-security-group]] - Assign security group to a specific IP address of a dedicated server
* [[Accounts-account-dedicatedServers-server-ipAddresses-ipaddress-os-security-groups:DELETE|DELETE /accounts/{accountId}/dedicatedServers/{serverId}/ipAddresses/{ipAddress}/os-security-groups/{groupId}]] - Unassign a specific security group from a specific IP of a dedicated server

== NAT Rules ==
* [[Accounts-accountId-dedicatedServers-serverId-ipAddresses-ipaddress-natRules:GET|GET /accounts/{accountId}/dedicatedServers/{serverId}/ipAddresses/{ipAddress}/natRules]] - Get all NAT rules, which are assigned to a specific IP address of a dedicated server
* [[Accounts-accountId-dedicatedServers-serverId-ipAddresses-ipaddress-natRules-ruleId:GET|GET /accounts/{accountId}/dedicatedServers/{serverId}/ipAddresses/{ipAddress}/natRules/{ruleId}]] - Get a specific NAT rule, which is assigned to a specific IP address of a dedicated server
* [[Accounts-accountId-dedicatedServers-serverId-ipAddresses-ipaddress-natRules:POST|POST /accounts/{accountId}/dedicatedServers/{serverId}/ipAddresses/{ipAddress}/natRules]] - Assign NAT rule to a specific IP address of a dedicated server
* [[Accounts-accountId-dedicatedServers-serverId-ipAddresses-ipaddress-natRules-ruleId:PUT|PUT /accounts/{accountId}/dedicatedServers/{serverId}/ipAddresses/{ipAddress}/natRules/{ruleId}]] - Update NAT rule for a specific IP address of a dedicated server
* [[Accounts-accountId-dedicatedServers-serverId-ipAddresses-ipaddress-natRules-ruleId:DELETE|DELETE /accounts/{accountId}/dedicatedServers/{serverId}/ipAddresses/{ipAddress}/natRules/{ruleId}]] - Unassign a specific NAT rule from a specific IP of a dedicated server

== Statistics ==
=== Traffic ===
* [[Accounts-accountId-dedicatedServers-serverId-statistics-traffic:GET|GET /accounts/{accountId}/dedicatedServers/{serverId}/statistics/traffic]] - Get traffic statistics by specific time range for a dedicated server
* [[Accounts-accountId-dedicatedServers-serverId-ipAddresses-ipaddress-statistics-traffic:GET|GET /accounts/{accountId}/dedicatedServers/{serverId}/ipAddresses/{ipAddress}/statistics/traffic]] - Get traffic statistics by specific time range for an IP address of a dedicated server
{{disqus}}
[[Category:Hostway API]]
[[Category:Dedicated Server API]]

Accounts-accountId-dedicatedServers-serverId-statistics-traffic:GET

2015-09-15T14:46:58Z

Jerry.dimitrov: Created page with "= GET /accounts/{accountId}/dedicatedServers/{serverId}/statistics/traffic = Get traffic statistics by specific time range for a dedicated server. __TOC__ === Request === <co..."

= GET /accounts/{accountId}/dedicatedServers/{serverId}/statistics/traffic =
Get traffic statistics by specific time range for a dedicated server.
__TOC__

=== Request ===
<code>GET /accounts/{accountId}/dedicatedServers/{serverId}/statistics/traffic?scope={scope}&startDate={startDate}&endDate={endDate}&period={period}''&''method={method}</code>

== URI Parameters ==
; accountId - ''string''
: ''(required)''
: The account Id of the dedicated server owner.

; serverId
: ''(required)''
: The specified dedicated server Id.

; scope
: ''(required)''
: The scope defines whether we want statistics for inbound or outbound traffic. Possible values: '''receive''' and '''transmit'''.

; startDate
: ''(required)''
: Start date that represents the beginning of the requested statistical time frame. The format should be '''yyyy-mm-dd'''.

; endDate
: ''(required)''
: End date that represents the end of the requested statistical time frame. The format should be '''yyyy-mm-dd'''.

; period
: ''(required)''
: Represents the granularity of the returned data sets for the requested time frame. Possible values: '''hourly''' or '''daily'''.

; method
: ''(required)''
: Statistics method used. Possible values: '''avg''','''sum''','''min''' and '''max'''.

=== Request Headers ===

;: {{Authorization}}
; Accept - HTTP Accept header [http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1]
: Possible values are ''application/json'', ''text/csv''. If omitted json will be returned.

== Date Format ==
: All dates are interpreted and represented in UTC with [http://www.iso.org/iso/home/standards/iso8601.htm ISO 8601 format]

== Response ==
=== Status Codes ===
; 200 OK
: Success

; 400 Bad Request
: Incorrect URI parameters.

; 401 Unauthorized
: The supplied credentials are invalid or do not provide permissions for this operation.

; 403 Forbidden
: The authorized user does not have permissions to access the resource or the requested time frame exceeds the maximum limit for the API.
: The current limit is 500 data sets per response entity, regardless of the period granularity.

; 404 Not Found
: The dedicated server or account does not exist.

=== Response Body ===
<nowiki>
[
{
"count": {count},
"date": "{date}",
"values": {values}
}
]</nowiki>

==== Parameters ====
; count - ''integer''
: The count of traffic operations for the specified period.

; date - ''string''
: The date time stamp for the specified period.

; values - ''float''
: The actual traffic value represented for the specified period.

== Examples ==
'''Successful response for total daily inbound traffic statistics'''
:'''GET''' /accounts/{accountId}/dedicatedServers/{serverId}/statistics/traffic?scope=receive&startDate=2015-05-05&endDate=2012-05-07&period=daily&method=sum

''Response Code:''
<pre>HTTP/1.1 200 OK</pre>

''Response Body:''
<nowiki>
[
{
"count": 143,
"date": "2015-05-05 00:00:00",
"values": 344130.30069930002
},
{
"count": 144,
"date": "2015-05-07 00:00:00",
"values": 658.34027777777999
},
]</nowiki>

'''Failure while trying to get traffic statistics and the number of returned data sets exceeds the maximum limit'''
:'''GET''' /accounts/{accountId}/dedicatedServers/{serverId}/statistics/traffic?scope=receive&startDate=2015-01-01&endDate=2015-05-05&period=daily&method=sum

''Response Code:''
<pre>HTTP/1.1 403 Forbidden</pre>

''Response Body:''
<nowiki>
{
"overLimit": {
"message": "GET data error",
"code": 403,
"details": "The (startDate, endDate) range is too large. Maximum number of returned data sets exceeded."
}
}</nowiki>

'''Failure while trying to get traffic statistics and the start date is before the create date (2015-01-01) of the dedicated server'''
:'''GET''' /accounts/{accountId}/dedicatedServers/{serverId}/statistics/traffic?scope=receive&startDate=2011-01-01&endDate=2015-05-05&period=daily&method=sum

''Response Code:''
<pre>HTTP/1.1 400 Bad Request</pre>

''Response Body:''
<nowiki>
{
"badRequest": {
"message": "GET data error",
"code": 400,
"details": {
"startDate": "2011-01-01 is less than minimum value 2015-01-01"
}
}
}</nowiki>

[[Category:Hostway API]]
[[Category:Dedicated Server API]]

Accounts-accountId-transactionsInfo:GET

2015-09-14T11:59:10Z

Jerry.dimitrov: /* Request Headers */

= GET /accounts/''{accountId}''/transactions =
Retrieves a list of all account's transactions
__TOC__
== Request ==
<code>GET /accounts/''{accountId}''/transactions</code>

==== Parameters ====
; accountId - ''string''
: The Id of the account.

=== URI Parameters ===
None.

=== Request Headers ===

;: {{Authorization}}
; Accept - HTTP Accept header [http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1]
: Possible values are ''application/json'', ''text/csv''. If omitted json will be returned.

== Response ==

=== Status Code ===
;200 OK
: Success

; 401 Unauthorized
: The supplied credentials are invalid or do not provide permissions for this operation.

;403 Forbidden
: The user lacks the necessary permissions to access the resource

;404 Not Found
: The account Id was not found.

=== Response Body ===
<nowiki>
{
{
"list": [{
"startDate": "{startDate}",
"endDate": "{endDate}",
"amount": {amount},
"description": "{description}",
"currency": "{currency}",
"date": "{date}",
"productSpecification": "",
"serviceNumber": "{serviceNumber}",
"type": "{type}",
"number": {number}
}],
"links" : [{
"href" : "https://api.hostway.com/accounts/{account_id}/transactions",
"rel" : "self"
}]
}
</nowiki>

==== Parameters ====
; list - ''list''
: A collection of dictionaries containing information about transactions

:; startDate - ''string''
:: Start date of transaction

:; endDate - ''string''
:: End date of transaction

:; ammount - ''integer''
:: Amount of transaction

:; description - ''string''
:: Description of transaction

:; currency - ''string''
:: Currency symbol of transaction

:; date - ''string''
:: Date of transaction

:; productSpecification - ''link''
:: URL link to the product specification

:; serviceNumber - ''string''
:: Service number info

:; type - ''string''
:: Type of transaction. Possible values are: 'charge', 'charge_back', 'payment', 'fee', 'refund', 'credit', 'cc_chargeback', 'charge_adjustment', 'discount', 'credit_adjustment', 'credit_proration', 'charge_proration', 'payment_adjustment', 'tax', 'cc_chargeback_reversal', 'usage_charge', 'write_off', 'undo_write_off', 'usage_discount'

:; number - ''int''
:: Transaction's number

:; links - ''list''
:: [[Hypermedia]] for the individual payment method

; links - ''list''
: [[Hypermedia]] for this resource. Links to self

== Examples ==

=== GET paginated transaction list call ===
'''Request'''

<nowiki>
GET {{APIBaseURL}}/accounts/test731993/transactions?page=1&pageSize=10
</nowiki>

'''Response'''
'''HTTP/1.1 200 OK'''
<nowiki>
{
"list" : [ {
"startDate": "2012-04-23",
"amount": 0.87,
"endDate": "2012-05-18",
"description": "Recurring fee Exchange 2010 Archiving, core.email.exchange2010.archiving 04/23/2012 through 05/18/2012",
"currency": "USD",
"date": "2012-04-23",
"productSpecification": "{{APIBaseURL}}/productSpecifications/test731993-00000137a32daee9e2b08715000a30fe33d32c",
"serviceNumber": "test731993-00000136dedf26dfd9ec22fd000a1ddba01da1",
"type": "charge",
"number": 101393524
}],
"links" : [
{
"href" : "{{APIBaseURL}}/accounts/test731993/transactions?page=1&pageSize=10",
"rel" : "self"
},
{
"href" : "{{APIBaseURL}}/accounts/test731993/transactions?page=2&pageSize=10",
"rel" : "next"
},
{
"href" : "{{APIBaseURL}}/accounts/test731993/transactions?page=44&pageSize=10",
"rel" : "last"
}]
}
</nowiki>

== See also ==
* [[Account|Account Management API]]
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Account Management API]]

ServerMonitoringDetailsBandwidth

2015-09-10T11:52:04Z

Jerry.dimitrov: /* Parameters */

This operation will list Bandwidth monitoring details for a specific [[Server]].

='''GET''' /accounts/''{accountId}''/flexcloud/servers/''{id}''/monitoring/bandwidth?''scope=monitoringScope''&''startDate=startDate''&''endDate=endDate''&''period=monitoringPeriod''&''method=statisticsMethod'''''=

== Parameters ==
; accountId - ''string''
: The selected account Id.

; id
: The unique identifier of the server.

; scope
: The monitoring scope used. Possible values: '''receive''' and '''transmit'''.

; startDate
: Start date for monitoring details report in format '''yyyy-mm-dd'''.

; endDate
: End date for monitoring details report in format '''yyyy-mm-dd'''.

; period
: The time period in seconds used for data interval. Possible values: '''3600'''(one hour) or '''86400'''(one day).

; method
: Statistics method used. Possible values: '''avg''','''sum''','''min''' and '''max'''.

== Date Format ==
: All dates are interpreted and represented in UTC with [http://www.iso.org/iso/home/standards/iso8601.htm ISO 8601 format]

== Result ==
=== JSON ===
<nowiki>
[
{
"count": 143,
"date": "2012-05-07 00:00:00",
"values": 344130.30069930002
},
{
"count": 144,
"date": "2012-05-08 00:00:00",
"values": 658.34027777777999
}
]</nowiki>

; count - ''integer''
: The count of bandwidth operations for the period specified.

; date - ''string''
: The date and time stamp for the period specified.

; values - ''float''
: The sample value calculated depending on statistics method used.

== Response Codes ==
; Success:
:''HTTP/1.1 200 OK''
:The request is accepted for processing.
; Failure:
:''HTTP/1.1 400 Bad Request''
:''HTTP/1.1 401 Unauthorized'' - This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.
:''HTTP/1.1 404 Not Found'' - The resource does not exist.

== Examples ==
'''Successfully get Bandwidth usage monitoring data'''
:'''GET''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/{server_name}/monitoring/bandwidth?scope=usage&startDate=2012-05-07&endDate=2012-05-10&period=86400&method=avg

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''Response Code:''
<pre>HTTP/1.1 200 OK</pre>

''Response Body:''
<nowiki>
[
{
"count": 143,
"date": "2012-05-07 00:00:00",
"values": 344130.30069930002
},
{
"count": 144,
"date": "2012-05-08 00:00:00",
"values": 658.34027777777999
},
{
"count": 144,
"date": "2012-05-09 00:00:00",
"values": 2.1111111111111001
}
]</nowiki>

'''Failure while trying to get Bandwidth usage monitoring data with a bad scope parameter'''
:'''GET''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/{server_name}/monitoring/bandwidth?scope=fake-scope&startDate=2012-05-07&endDate=2012-05-10&period=86400&method=avg

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''Response Code:''
<pre>HTTP/1.1 400 Bad Request</pre>

''Response Body:''
<nowiki>
{
"badRequest": {
"message": "Bad request",
"code": 400,
"details": "The bandwidth monitoring scope is not supported",
"errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
}
}</nowiki>

'''Failure while trying to get Bandwidth usage monitoring data with a bad date parameter'''
:'''GET''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/{server_name}/monitoring/bandwidth?scope=usage&startDate=fake-date&endDate=2012-05-10&period=86400&method=avg

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''Response Code:''
<pre>HTTP/1.1 400 Bad Request</pre>

''Response Body:''
<nowiki>
{
"badRequest": {
"message": "Bad request",
"code": 400,
"details": {
"startDate": "Invalid date"
},
"errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
}
}</nowiki>

'''Failure while trying to get Bandwidth usage monitoring data with a bad period parameter'''
:'''GET''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/{server_name}/monitoring/bandwidth?scope=usage&startDate=2012-05-07&endDate=2012-05-10&period=fake-period&method=avg

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''Response Code:''
<pre>HTTP/1.1 400 Bad Request</pre>

''Response Body:''
<nowiki>
{
"badRequest": {
"message": "Bad request",
"code": 400,
"details": {
"period": "\"fake-period\" is not a number"
},
"errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
}
}</nowiki>

'''Failure while trying to get Bandwidth usage monitoring data with a bad method parameter'''
:'''GET''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/{server_name}/monitoring/bandwidth?scope=usage&startDate=2012-05-07&endDate=2012-05-10&period=86400&method=fake-method

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''Response Code:''
<pre>HTTP/1.1 400 Bad Request</pre>

''Response Body:''
<nowiki>
{
"badRequest": {
"message": "Bad request",
"code": 400,
"details": "Invalid statistics_method",
"errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
}
}</nowiki>

'''Failure while trying to get Bandwidth usage monitoring data with a missing scope parameter'''
:'''GET''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/{server_name}/monitoring/bandwidth?startDate=2012-05-07&endDate=2012-05-10&period=86400&method=avg

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''Response Code:''
<pre>HTTP/1.1 400 Bad Request</pre>

''Response Body:''
<nowiki>
{
"badRequest": {
"message": "Bad request",
"code": 400,
"details": "The bandwidth monitoring scope is missing",
"errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
}
}</nowiki>

'''Failure while trying to get Bandwidth usage monitoring data with a missing date parameter'''
:'''GET''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/{server_name}/monitoring/bandwidth?scope=usage&endDate=2012-05-10&period=86400&method=avg

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''Response Code:''
<pre>HTTP/1.1 400 Bad Request</pre>

''Response Body:''
<nowiki>
{
"badRequest": {
"message": "Bad request",
"code": 400,
"details": {
"startDate": "Required"
},
"errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
}
}</nowiki>

'''Failure while trying to get Bandwidth usage monitoring data with a missing period parameter'''
:'''GET''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/{server_name}/monitoring/bandwidth?scope=usage&startDate=2012-05-07&endDate=2012-05-10&method=avg

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''Response Code:''
<pre>HTTP/1.1 400 Bad Request</pre>

''Response Body:''
<nowiki>
{
"badRequest": {
"message": "Bad request",
"code": 400,
"details": {
"period": "Required"
},
"errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
}
}</nowiki>

'''Failure while trying to get Bandwidth usage monitoring data with a missing method parameter'''
:'''GET''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/{server_name}/monitoring/bandwidth?scope=usage&startDate=2012-05-07&endDate=2012-05-10&period=86400

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''Response Code:''
<pre>HTTP/1.1 400 Bad Request</pre>

''Response Body:''
<nowiki>
{
"badRequest": {
"message": "Bad request",
"code": 400,
"details": {
"method": "Required"
},
"errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
}
}</nowiki>

'''Failure while trying to get Bandwidth usage monitoring data for a non-existent server'''
:'''GET''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/{fake-server_name}/monitoring/bandwidth?scope=usage&startDate=2012-05-07&endDate=2012-05-10&period=86400&method=avg

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''Response Code:''
<pre>HTTP/1.1 404 Not Found</pre>

''Response Body:''
<nowiki>
{
"itemNotFound": {
"message": "Resource not found",
"code": 404,
"details": "",
"errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
}
}</nowiki>

'''Unauthorized access'''
:'''GET''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/{server_name}/monitoring/bandwidth?scope=usage&startDate=2012-05-07&endDate=2012-05-10&period=86400&method=avg

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded fake_authentication_string

''Response Code:''
<pre>HTTP/1.1 401 Unauthorized</pre>

''Response Body:''
401 Unauthorized
This server could not verify that you are authorized to
access the document you requested. Either you supplied the
wrong credentials (e.g., bad password), or your browser
does not understand how to supply the credentials required.

'''Failure while trying to pass invalid account number'''
:'''GET''' http(s)://{api_server}/accounts/fake/flexcloud/servers/{server_name}/monitoring/bandwidth?scope=usage&startDate=2012-05-07&endDate=2012-05-10&period=86400&method=avg

''Response Code:''
<pre>HTTP/1.1 404 Not Found</pre>

''Response Body:''
<nowiki>
{
"itemNotFound" : {
"message": "Resource not found",
"code": 404,
"details": "",
"errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
}
}</nowiki>

== Alternative URI /servers/{id}/monitoring/bandwidth ==
An alternative way to execute this call is to omit the ''accountId'' portion of the URI. In this case the system assumes the request is executed for the account identified in the [[Authentication|authorization header]].

<code>GET /servers/{id}/monitoring/bandwidth</code>

[[Category:Hostway API]]
[[Category:FlexCloud Server API]]

ServiceAttributes-dedicated.server.firewall

2015-07-02T12:43:33Z

Jerry.dimitrov: Created page with "= Dedicated Server Firewall Service Attributes = Attributes used when configuring the Dedicated Server Firewall service. __TOC__ == Attributes Body == <nowiki> { "serverFi..."

= Dedicated Server Firewall Service Attributes =
Attributes used when configuring the Dedicated Server Firewall service.
__TOC__

== Attributes Body ==
<nowiki>
{
"serverFirewallType": "{type}"
}
</nowiki>

==== Parameters ====
; serverFirewallType
: Actual type of the dedicated server firewall. Possible values - '''shared''' or '''dedicated'''.

== See also ==
* [[ServiceAttributesStructure|Service Attributes Structure]]
* [[Orders|Orders API]]
* [[Account|Account Management API]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Ordering API]]
[[Category:Account Management API]]

ServiceAttributesStructure

2015-07-02T12:36:01Z

Jerry.dimitrov:

Services supported by Hostway Public Order API:

* [[ServiceAttributes-core.webhosting|Web Hosting]]
* [[ServiceAttributes-core.dnr|Domain Name Registration]]
* [[ServiceAttributes-core.subdomain|Sub-Domain Registration]]
* [[ServiceAttributes-core.dedserver|Dedicated Server]]
* [[ServiceAttributes-dedicated.server.firewall|Dedicated Server Firewall]]
* [[ServiceAttributes-core.email.exchange2010|Exchange2010]]
* [[ServiceAttributes-dnr.feature.private_registration|WhoisProtector (Private Registration)]]
* [[ServiceAttributes-dnr.feature.domain_guard|DomainGuard]]
* [[ServiceAttributes-core.vps.virtuozzo.server|VPS Virtuozzo Server]]
* [[ServiceAttributes-core.websplanet|WebsPlanet]]
* [[ServiceAttributes-mcafee|Excel Micro]]
* [[ServiceAttributes-core.cloud.hscc|Cloud Compute]]

== See also ==
* [[Orders|Orders API]]
* [[Account|Account Management API]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Ordering API]]
[[Category:Account Management API]]

Accounts-accountId-dedicatedFirewalls-availability:GET

2015-07-02T11:26:44Z

Jerry.dimitrov: /* URI Parameters */

= GET /accounts/{accountId}/dedicatedFirewalls/availability =
Check for dedicated firewall product availability by a specific account and optional location.
__TOC__

== Request ==
<code>GET /accounts/{accountId}/dedicatedFirewalls/availability</code>

==== Request Parameters ====
; accountId - ''string''
: The Id of the account.

==== URI Parameters ====
; location - ''string''
: ''(OPTIONAL)''
: Text key of the dedicated firewall location.
: Omitting the location will result in search for dedicated firewall product, regardless of location.

=== Request Headers ===
{{Authorization}}

== Response ==

=== Status Code ===
; 204 No Content
: There is at least one existing dedicated firewall product with the specified criteria.

; 401 Unauthorized
: The supplied credentials are invalid or do not provide permissions for this operation.

; 403 Forbidden
: The authorized user does not have permissions to access the resource.

; 404 Not Found
: There is no existing dedicated firewall products with the specified criteria.

== Examples ==

=== Availability check for dedicated firewall product, regardless of location ===
'''Request'''
<nowiki>
GET /accounts/{accountId}/dedicatedFirewalls/availability
</nowiki>

'''Response'''
<nowiki>
204 No Content
</nowiki>

=== Availability check for dedicated firewall product in a particular location ===
'''Request'''
<nowiki>
GET /accounts/{accountId}/dedicatedFirewalls/availability?location=location_text_key
</nowiki>

'''Response'''
<nowiki>
204 No Content
</nowiki>

{{disqus}}
[[Category:Dedicated Server API]]

Dedicated Firewall API

2015-07-02T11:21:40Z

Jerry.dimitrov:

__TOC__
[{{fullurl:{{FULLPAGENAMEE}}|action=pdfbook}} download this selection of articles as a PDF book]

== Dedicated Firewalls ==
* [[Accounts-accountId-dedicatedFirewalls-availability:GET|GET /accounts/{accountId}/dedicatedFirewalls/availability]] - Check for dedicated firewall product availability by a specific account and optional location

{{disqus}}
[[Category:Hostway API]]
[[Category:Dedicated Firewall API]]

Account

2015-07-02T11:17:13Z

Jerry.dimitrov:

= 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.
__TOC__
[{{fullurl:{{FULLPAGENAMEE}}|action=pdfbook}} download this selection of articles as a PDF book]

== Account Management ==
* [[Accounts:GET|GET /accounts]] - Returns list of accounts authorized for access with the provided credentials
* [[Accounts-accountId:GET|GET /accounts/{accountId}]] - Returns information about an account
* [[Accounts-accountId:GET#Alternative_with_partner_Id|GET /partnerAccounts/{partnerAccountId}]] - Returns information about an account specified by its partner Id
* [[Accounts-accountId:PUT|PUT /accounts/{accountId}]] - Updates account status
* [[Accounts-accountId:PUT#Alternative_with_partner_Id|PUT /partnerAccounts/{partnerAccountId}]] - Updates account status for account specified by its partner Id
* [[Accounts-accountId:DELETE|DELETE /accounts/{accountId}]] - Purges an account from the system
* [[Accounts-accountId:DELETE#Alternative_with_partner_Id|DELETE /partnerAccounts/{partnerAccountId}]] - Purges an account specified by its partner Id from the system

==Account Attributes Management ==
* [[Accounts-accountId-attributes:GET|GET /accounts/{accountId}/attributes]] - Returns list of attributes
* [[PartnerAccounts-partnerAccountId-attributes:GET|GET /partnerAccounts/{partnerAccountId}/attributes]] - Returns list of attributes using Partner Account Id
* [[Accounts-accountId-attributes:POST|POST /accounts/{accountId}/attributes]] - Creates new attribute
* [[PartnerAccounts-partnerAccountId-attributes:POST|POST /partnerAccounts/{partnerAccountId}/attributes]] - Creates new attribute using Partner Account Id
* [[Accounts-accountId-attributes-attribute:GET|GET /accounts/{accountId}/attributes/{attribute}]] - Gets attribute using Account ID
* [[PartnerAccounts-partnerAccountId-attributes-attribute:GET|GET /partnerAccounts/{partnerAccountId}/attributes/{attribute}]] - Gets attribute using Partner Account Id
* [[Accounts-accountId-attributes-attribute:PUT|PUT /accounts/{accountId}/attributes/{attribute}]] - Updates attribute value
* [[PartnerAccounts-partnerAccountId-attributes-attribute:PUT|PUT /partnerAccounts/{partnerAccountId}/attributes/{attribute}]] - Updates attribute value using Partner Account Id
* [[Accounts-accountId-attributes-attribute:DELETE|DELETE /accounts/{accountId}/attributes/{attribute}]] - Deletes attribute
* [[PartnerAccounts-partnerAccountId-attributes-attribute:DELETE|DELETE /partnerAccounts/{partnerAccountId}/attributes/{attribute}]] - Deletes attribute using Partner Account Id

== Contacts Management ==
* [[Accounts-accountId-Contacts:GET|GET /accounts/{accountId}/contacts]] - Returns all contacts for an account
* [[Accounts-accountId-Contacts-contactType:GET|GET /accounts/{accountId}/contacts/{contactType}]] - Returns specific contact type for an account
* [[Accounts-accountId-Contacts:PUT|PUT /accounts/{accountId}/contacts]] - Set all contacts for an account
* [[Accounts-accountId-Contacts-contactType:PUT|PUT /accounts/{accountId}/contacts/{contactType}]] - Set specific contact type for an account

=== Actions ===
*[[Initiate-Email-Verification-Action:POST|POST /accounts/{account_number}/contacts/action]] - Initiate Email Verification Action

=== ZenDesk SSO Link ===
*[[ZenDesk-SSO-Link-Per-Contact-Type:GET|GET /accounts/{accountId}/contacts/{contactType}/supportSSOLink]] - Returns ZendDesk SSO Link Per Contact Type

== Users Management ==
* [[Accounts-accountId-users:GET|GET /accounts/{accountId}/users]] - Returns a list of users in the account
* [[Accounts-accountId-users:POST|POST /accounts/{accountId}/users]] - Creates a new user in the account
* [[Accounts-accountId-users-userName:GET|GET /accounts/{accountId}/user/{userName}]] - Returns the details of a specific user in the account
* [[Accounts-accountId-users-userName:PUT|PUT /accounts/{accountId}/user/{userName}]] - Updates the user details (password, security question/answer)
* [[Accounts-accountId-user:PUT|PUT /accounts/{accountId}/user]] - (Deprecated) Updates the user details (password, security question/answer) of a user
* [[Accounts-accountId-users-userName:DELETE|DELETE /accounts/{accountId}/user/{userName}]] - Deletes a user
* [[Accounts-accountId-users-userName-roles:GET|GET /accounts/{accountId}/user/{userName}/roles]] - Returns the list of roles of a user
* [[Accounts-accountId-users-userName-roles:PUT|PUT /accounts/{accountId}/user/{userName}/roles]] - Updates the list of roles of a user

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

== Products Bandwidth Management ==
* [[Accounts-accountId-products-productId-bandwidth-daily:GET|GET /accounts/{accountId}/products/{productId}/bandwidth/daily?filterType={filterType}&from={filterStartDate}&to={filterEndDate}]] - Get a report on the daily bandwidth usage of the product
* [[Accounts-accountId-products-productId-bandwidth-weekly:GET|GET /accounts/{accountId}/products/{productId}/bandwidth/weekly?filterType={filterType}&from={filterStartDate}&to=filterEndDate}]] - Get a report on the weekly bandwidth usage of the product
* [[Accounts-accountId-products-productId-bandwidth-monthly:GET|GET /accounts/{accountId}/products/{productId}/bandwidth/monthly?filterType={filterType}&from={filterStartDate}&to=filterEndDate}]] - Get a report on the monthly bandwidth usage of the product
* [[Accounts-accountId-products-productId-bandwidth-yearly:GET|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 ==
* [[Accounts-accountId-products-productId-usage:GET|GET /accounts/{accountId}/products/{productId}/usage]] - Get an aggregated services usage report of a product

== Payment info ==
* [[Accounts-accountId-paymentInfo:GET|GET /accounts/{accountId}/paymentInfo]] - Get a list of active payment methods
* [[Accounts-accountId-paymentInfo:POST|POST /accounts/{accountId}/paymentInfo]] - Add a payment method for a given account
* [[Accounts-accountId-paymentInfo-default:PUT|PUT /accounts/{accountId}/paymentInfo/default]] - Set the default payment method
* [[Accounts-accountId-paymentInfo-default:DELETE|DELETE /accounts/{accountId}/paymentInfo/default]] - Unset the default payment method
* [[Accounts-accountId-paymentInfo-paymentInfoId:GET|GET /accounts/{accountId}/paymentInfo/{paymentInfoId}]] - Get information about an active payment method
* [[Accounts-accountId-paymentInfo-paymentInfoId:DELETE|DELETE /accounts/{accountId}/paymentInfo/{paymentInfoId}]] - Remove an active payment method
* [[Accounts-accountId-paymentInfo-paymentInfoId-payment:POST|POST /accounts/{accountId}/paymentInfo/{paymentInfoId}/payment]] - Make a one-time payment toward the account balance

== Transactions ==
* [[Accounts-accountId-transactionsInfo:GET|GET /accounts/{accountId}/transaction]] - Get a list of account's transactions
* [[Accounts-accountId-transactionsInfo-filtered-type:GET|GET /accounts/{accountId}/transaction?filterType={filterType}]] - Get a list of account's transactions filtered by Transaction type
* [[Accounts-accountId-transactionsInfo-sorted:GET|GET /accounts/{accountId}/transaction?sortField={sortField}]] - Get a list of account's transactions sorted by sortField param

== Invoices ==
* [[Accounts-accountId-invoicesInfo:GET|GET /accounts/{accountId}/invoices]] - Get a list of account's invoices
* [[Accounts-accountId-invoicesInfo-filtered-status:GET|GET /accounts/{accountId}/invoices?filterStatus={filterStatus}]] - Get a list of account's invoices filtered by Invoice status
* [[Accounts-accountId-invoicesInfo-sorted:GET|GET /accounts/{accountId}/invoices?sortField={sortField}]] - Get a list of account's invoices sorted by sortField param
* [[Accounts-accountId-invoicesInfo-invoiceId:GET|GET /accounts/{accountId}/invoices/{invoiceId}]] - Get invoice info or pdf

== Invoice Transactions ==
* [[Accounts-accountId-invoices-invoiceId-transactions:GET|GET /accounts/{accountId}/invoices/{invoiceId}/transactions]] - Get a list of invoice transactions

== 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.
* [[Accounts-accountId-os-security-groups:GET|GET /accounts/{accountId}/os-security-groups]] - Get a list of account's firewall groups
* [[Accounts-accountId-os-security-groups:POST|POST /accounts/{accountId}/os-security-groups]] - Create firewall group for account
* [[Accounts-accountId-os-security-groups-groupId:GET|GET /accounts/{accountId}/os-security-groups/{groupId}]] - Get firewall group details
* [[Accounts-accountId-os-security-groups-groupId:PUT|PUT /accounts/{accountId}/os-security-groups/{groupId}]] - Update firewall group
* [[Accounts-accountId-os-security-groups-groupId:DELETE|DELETE /accounts/{accountId}/os-security-groups/{groupId}]] - Delete firewall group
* [[Accounts-accountId-os-security-group-rules:POST|POST /accounts/{accountId}/os-security-group-rules]] - Create firewall group rule
* [[Accounts-accountId-os-security-group-rules-ruleId:DELETE|DELETE /accounts/{accountId}/os-security-group-rules/{ruleId}]] - Delete firewall group rule

== See also ==
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Account Management API]]

Accounts-accountId-dedicatedServers-serverId-ipAddresses-ipaddress-natRules-ruleId:DELETE

2015-07-01T13:07:37Z

Jerry.dimitrov: Created page with "= DELETE /accounts/{accountId}/dedicatedServers/{serverId}/ipAddresses/{ipAddress}/natRules/{ruleId} = Unassign a specific NAT rule from a specific IP of a dedicated server __..."

= DELETE /accounts/{accountId}/dedicatedServers/{serverId}/ipAddresses/{ipAddress}/natRules/{ruleId} =
Unassign a specific NAT rule from a specific IP of a dedicated server
__TOC__

== Request ==
<code>DELETE /accounts/{accountId}/dedicatedServers/{serverId}/ipAddresses/{ipAddress}/natRules/{ruleId}</code>

==== Request Parameters ====
; accountId - ''string''
: The user account owning the dedicated server
; serverId - ''string''
: The specified dedicated server Id
; ipAddress - ''string''
: The specified IP address of the dedicated server
; ruleId - ''string''
: The specific NAT rule Id

==== Request Headers ====
{{Authorization}}

== Response ==

=== Status Code ===
; 204 No Content
: Success

; 401 Unauthorized
: The supplied credentials are invalid or do not provide permissions for this operation.

; 403 Forbidden
: The authorized user does not have permissions to access the resource.

; 404 Not Found
: The specific NAT rule resource does not exist.

== Examples ==

=== Unassign a specific NAT rule from a specific dedicated server IP ===
'''Request'''
<nowiki>
DELETE /accounts/test-acount/dedicatedServers/test-server-213/ipAddresses/1.1.1.1/natRules/test-rule-1
</nowiki>

'''Response'''
<nowiki>
204 No Content
</nowiki>

{{disqus}}
[[Category:Dedicated Server API]]

Orders:POST

2015-07-01T11:51:45Z

Jerry.dimitrov: /* Create without permission to pass client IP */

= POST /orders =
Creates a new order and returns the unique order URI.
__TOC__

== Request ==
<code>POST /orders</code>

=== URI Parameters ===
None.

=== Request Headers ===
; Content-Type
: Required. Set this header to <code>application/json; charset=UTF-8</code>

; Cookie
: Optional. A cookie named '''OwnerId''' may be specified to identify the client (for most browser clients, the browser will do this automatically, depending on the browser configuration). The value of the cookie would come from the response to a previous request for this resource (in the '''Set-Cookie''' response header).

=== Request Body ===
<nowiki>
{
"clientIp": {client_ip_address}
}
</nowiki>

==== Parameters ====
; clientIp - ''string''
: Optional. The IP address of the client that submitted the order. If not provided, the IP address of the client that called the API will be used. The IP address may be used to check the order for possible fraud. This parameter may be useful in cases where the API client accepts and relays orders from a 3rd-party customer (such as a shopping cart application). This parameter requires elevated permissions.

== Response ==

=== Status Code ===
{| class="wikitable"
! Status Code
! Error Message
! Description
|-
| 201 Created
| align="center" | -
| The new order was created.
|-
| 400 Bad Request
| User cannot specify the client IP address
| The client attempted to pass the client IP address and is not allowed. Use of this parameter requires elevated permissions.
|-
| 409 Conflict
| A new order has already been created for this ownerID
| The client already has an open order. If the '''OwnerId''' cookie was passed in the request headers, a 409 will be returned if there's already an open (unsubmitted) order for the same client.
|}

=== Response Headers ===
; Location
: Returned with successful response. Contains the order URI. The client must use this URI for all subsequent operations with the order.

; Set-Cookie
: Returned with successful response. Contains an '''OwnerId''' value which must be submitted with all subsequent requests for this order. The '''OwnerId''' identifies the client and prohibits it from having more than one open (unsubmitted) orders.

=== Response Body ===
<nowiki>
{
"orderId": "{orderId}",
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/", "rel": "self"},
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/{orderId}", "rel": "item"}
]
}</nowiki>

==== Parameters ====
; orderId - ''string''
: The Id of the new order

; links - ''list''
: [[Hypermedia]] for this resource. Links to self and the newly created order.

== Example ==

=== Create Order successfully ===
'''Request'''
<nowiki>
POST /orders
Content-Type: application/json; charset=UTF-8

{}</nowiki>

'''Response'''
<nowiki>
201 Created
Content-Type: application/json; charset=UTF-8
Location : </nowiki>{{APIBaseURL}}<nowiki>/orders/0000013ad6dd95746a399f90000a71384bf242cf
Set-Cookie : OwnerId=b0d6352a-f66a-476d-8e1d-2f3f9dea5c49; Path=/

{
"orderId": "0000013ad6dd95746a399f90000a71384bf242cf",
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/", "rel": "self"},
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/0000013ad6dd95746a399f90000a71384bf242cf", "rel": "item"}
]
}</nowiki>

=== Create without permission to pass client IP ===
'''Request'''
<nowiki>
POST /orders
Content-Type: application/json; charset=UTF-8
Authorization: Basic AuthString
{
"clientIp": "1.2.3.4"
}</nowiki>

'''Response'''
<nowiki>
400 Bad Request
Content-Type: application/json; charset=UTF-8

{
"computeFault": {
"guid": "143336cd-1763-4fe9-b3e3-c1e172b14fae",
"message": "User cannot specify the client IP address",
"code": 400, "details": ""
}
}</nowiki>

=== An open order already exists ===
'''Request'''
<nowiki>
POST /orders
Content-Type: application/json; charset=UTF-8
Cookie: OwnerId=0b3fc7bd-6905-4de7-bddb-43d2c7365e7a

{}</nowiki>

'''Response'''
<nowiki>
409 Conflict
Content-Type: application/json; charset=UTF-8

{
"conflict": {
"guid": "e250bf7e-688d-45ba-8308-58374529be58",
"message": "A new order has already been created for this ownerID",
"code": 409,
"details": ""
}
}</nowiki>

== See also ==
* [[Orders|Orders API]]
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Ordering API]]

Accounts-account-dedicatedServers-server-ipAddresses-ipaddress-os-security-groups:GET

2015-06-30T12:03:14Z

Jerry.dimitrov:

= GET /accounts/{accountId}/dedicatedServers/{serverId}/ipAddresses/{ipAddress}/os-security-groups =
Get all security groups, which are assigned to a specific IP address of a dedicated server
__TOC__

== Request ==
<code>GET /accounts/{accountId}/dedicatedServers/{serverId}/ipAddresses/{ipAddress}/os-security-groups</code>

==== Request Parameters ====
; accountId - ''string''
: The user account owning the dedicated server
; serverId - ''string''
: The specified dedicated server Id
; ipAddress - ''string''
: The specified IP address of the dedicated server

=== URI Parameters ===

; page - ''integer''
: Specifies which page should be displayed. Requires a pageSize parameter to also be provided

; pageSize - ''integer''
: Specifies the number of entries to be displayed on a page. Requires a page parameter to also be provided

; unassigned - ''string''
: If set to "true", all unassigned groups against the given IP address will be shown.

== Response ==

=== Status Code ===
; 200 OK
: Success

; 401 Unauthorized
: The supplied credentials are invalid or do not provide permissions for this operation.

; 404 Not Found
: The domain name or account does not exist.

=== Response Body ===
<nowiki>
{
"totalCount": 1,
"list": [
{
"status": "{status}",
"displayName": "{displayName}",
"description": "{description}",
"rules": [
{
"startPort": "{startPort}",
"name": "{name}",
"priority": "{priority}",
"fromCidr": "{fromCidr}",
"action": "{action}",
"protocol": "{protocol}"
"endPort": "{endPort}"
}
],
"serverName": {serverName},
"groupId": {groupId},
}
],
"links": [
{
"href": {resourceURL},
"rel": "self"
}
]

}
</nowiki>

==== Parameters ====
; status - ''string'' - one of "enabled" or "disabled"
: The status of the group

; displayName - ''string''
: The display name of the firewall group.

; description - ''string''
: Text describing the firewall group.

; startPort - ''integer''
: Start port number

; name - ''string''
: The displayname of the rule

; priority - ''integer''
: rule priority, starting from 0 lowest priority

; fromCidr - ''string''
: CIDR notation IP address.

; action - ''string''
: rule target action
: ACCEPT, REJECT or DROP

; protocol - ''string''
: TCP, UDP, AH, ESP, GRE, AH+ESP, ALL(all protocols)
: AH, ESP, GRE, AH+ESP, ALL protocols don't support port - both should be 0

; endPort - ''integer''
: End port number

; serverName - ''string''
: The display name of the dedicated server

; groupId - ''string''
: The unique ID of the security group

== Examples ==

=== Success getting a security group ===
'''Request'''
<nowiki>
GET /accounts/test-acount/dedicatedServers/test-acount-213/ipAddresses/1.1.1.1/os-security-groups
</nowiki>

'''Response'''
<nowiki>
{
"totalCount": 1,
"list": [
{
"status": "ENABLED",
"displayName": "dedicated_test_sec_gr",
"description": "A test group",
"rules":
[
{
"startPort": 80,
"name": "rule2015May28_A3iOEGDrJVeC",
"priority": 0,
"fromCidr": "127.0.0.1/24",
"action": "ACCEPT",
"protocol": "TCP",
"endPort": 80
}
],
"serverName": "servername",
"groupId": "group2015May28_1QBhG4AvTnxD"
}
],
"links": [
{
"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/test-acount/dedicatedServers/test-acount-213/ipAddresses/1.1.1.1/os-security-groups/",
"rel": "self"
}
]
}
</nowiki>

=== Paginated request ===
'''Request'''
<nowiki>
GET /accounts/test-acount/dedicatedServers/test-acount-213/ipAddresses/1.1.1.1/os-security-groups?page=2&pageSize=2
</nowiki>

'''Response'''
<nowiki>
{
"totalCount": 6,
"list": [
{
"status": "ENABLED",
"displayName": "dedicated_test_sec_gr_1",
"description": "A test group 1",
"rules":
[
{
"startPort": 80,
"name": "rule2015May28_A3iOEGDrJVeC",
"priority": 0,
"fromCidr": "127.0.0.1/24",
"action": "ACCEPT",
"protocol": "TCP",
"endPort": 80
}
],
"serverName": "servername",
"groupId": "group2015May28_1QBhG4AvTnxD"
},
{
"status": "ENABLED",
"displayName": "dedicated_test_sec_gr_1",
"description": "A test group 1",
"rules":
[
{
"startPort": 80,
"name": "rule2015May28_A7i8EGDrJVeC",
"priority": 0,
"fromCidr": "127.0.0.1/24",
"action": "ACCEPT",
"protocol": "TCP",
"endPort": 80
}
],
"serverName": "servername",
"groupId": "group2015May28_A7i8EGDrJVeC"
}
],
"links": [
{
"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/test-acount/dedicatedServers/test-acount-213/ipAddresses/1.1.1.1/os-security-groups?page=1&pageSize=2",
"rel": "first"
},
{
"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/test-acount/dedicatedServers/test-acount-213/ipAddresses/1.1.1.1/os-security-groups?page=1&pageSize=2",
"rel": "previous"
},
{
"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/test-acount/dedicatedServers/test-acount-213/ipAddresses/1.1.1.1/os-security-groups?page=3&pageSize=2",
"rel": "next"
},
{
"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/test-acount/dedicatedServers/test-acount-213/ipAddresses/1.1.1.1/os-security-groups?page=3&pageSize=2",
"rel": "last"
},
{
"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/test-acount/dedicatedServers/test-acount-213/ipAddresses/1.1.1.1/os-security-groups/",
"rel": "self"
}
]
}
</nowiki>
{{disqus}}
[[Category:Dedicated Server API]]

Accounts-accountId-paymentInfo-paymentInfoId:DELETE

2015-06-12T14:56:33Z

Jerry.dimitrov: /* Parameters */

= DELETE /accounts/''{accountId}''/paymentInfo/''{paymentInfoId}'' =
Removes a given payment method. If the payment method is the current default, it cannot be removed

__TOC__
== Request ==
<code>DELETE /accounts/''{accountId}''/paymentInfo/''{paymentInfoId}'' </code>

==== Parameters ====
; accountId - ''string''
: The Id of the account.

; paymentInfoId - ''string''
: The Id of the payment method.
: '''Note''': Default payment info can be unset only with agent credentials.

=== URI Parameters ===
None.

=== Request Headers ===
{{Authorization}}

=== Request Body ===
None.

== Response ==

=== Status Code ===
; 204 No Content
: Successful removal

; 403 Forbidden
: The current user is not allowed to delete this payment method

; 404 Not Found
: The account or payment info was not found

; 409 Conflict
: Cannot delete the current default payment method

=== Response Body ===
None.

== See also ==
* [[Account|Account Management API]]
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Account Management API]]

Orders-orderId-account-paymentInfo:GET

2015-06-12T12:21:31Z

Jerry.dimitrov: /* Response Body */

= GET /orders/''{orderId}''/account/paymentInfo =
Get the payment method information for a given order. Only a minimum amount of information will be returned to recognize the payment method.
__TOC__

== Request ==
<code>GET /orders/''{orderId}''/account/paymentInfo</code>

==== Request Parameters ====
{{UriParameter-OrderId}}

=== URI Parameters ===
None.

=== Request Headers ===
{{Cookie-OwnerId}}

== Response ==

=== Status Code ===
{| class='wikitable'
|-
! Status Code
! Error Message
! Description
|-
| 200 OK
| align="center" | -
| The operation was successfully completed.
|-
| 401 Unauthorized
| align="center" | -
| No owner Id specified or the specified owner is not authorized to get payment info for this order.
|-
| 403 Forbidden
| Unauthorized: PaymentInfo failed permission check
| An unauthorized user cannot set or get payment info.
|-
| rowspan="3" | 404 Not Found
| Resource not found
| The specified order does not exist.
|-
| rowspan="2" align="center" | -
| An account was not set for the order.
|-
| No payment info for the order was found.
|-
| 502 Bad Gateway
| align="center" | -
| Unexpected backend error
|}

=== Response Body ===
The following is the response body for credit cards.
<nowiki>
{
"paymentInfoType": "credit_card",
"accountNumber": "************1111",
"creditCardType": "visa",
"expirationDate": "2012-08",
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/{order_id}/account/paymentInfo/", "rel": "self"}
]
}
</nowiki>

The following is the response for Verizon payment information.
<nowiki>
{
"paymentInfoType": "vz_payment",
"paymentReference": "123432429034",
"sessionId": "23432434244",
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/{order_id}/account/paymentInfo/", "rel": "self"}
]
}
</nowiki>

The following is the response for offline payment information.
<nowiki>
{
"paymentInfoType": "offline",
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/{order_id}/account/paymentInfo/", "rel": "self"}
]
}
</nowiki>

==== Parameters ====
; paymentInfoType - ''string''
: The type of payment method. Possible value(s) are:
:: '''credit_card'''
:: '''vz_payment'''
:: '''offline'''

; accountNumber - ''string''
: The credit card number. Only the last four digits will be revealed. Only applies for credit cards.

; creditCardType - ''string''
: The type of credit card such as visa, mastercard, discover, etc. Only applies for credit cards.

; expirationDate - ''string''
: The credit card expiration date in YYYY-MM format. Only applies for credit cards.

; paymentReference - ''string''
: Verizon payment reference id. Only applies for Verizon payment type.

; sessionId - ''string''
: Verizon payment session id. Only applies for Verizon payment type.

; links - ''list''
: [[Hypermedia]] for this resource. Links to self.

== Example ==
=== Success ===
'''Request'''
<nowiki>
GET /orders/{orderId}/account/paymentInfo
Cookie: OwnerId={owner_id}; Path=/</nowiki>

'''Response'''
<nowiki>
200 OK
Content-Type : application/json; charset=UTF-8

{
"links": [{
"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/00000148546ce1ac1d12585e007f000000010001/account/paymentinfo/",
"rel": "self"
}],
"creditCardType": "visa",
"expirationDate": "2015-06",
"paymentInfoType": "credit_card",
"accountNumber": "************1111"
}</nowiki>

=== No authorization ===
'''Request'''
<nowiki>
GET /orders/{orderId}/account/paymentInfo
Cookie: OwnerId={wrong_owner_id}; Path=/</nowiki>

'''Response'''
<nowiki>
401 Unauthorized
Content-Type : text/plain; charset=UTF-8

401 Unauthorized

This server could not verify that you are authorized to access the document you requested.
Either you supplied the wrong credentials (e.g., bad password),
or your browser does not understand how to supply the credentials required.</nowiki>

=== Unauthorized user ===
'''Request'''
<nowiki>
GET /orders/{orderId}/account/paymentInfo
Authorization: Basic {wrong_user_authorization}</nowiki>

'''Response'''
<nowiki>
403 Forbidden
Content-Type : application/json; charset=UTF-8

{
"forbidden": {
"guid": "5a199170-843a-44fc-bbb0-87155eb15fc6",
"message": "Unauthorized: PaymentInfo failed permission check",
"code": 403,
"details": ""
}
}</nowiki>

=== Order does not exist ===
'''Request'''
<nowiki>
GET /orders/{non-existent_orderId}/account/paymentInfo
Cookie: OwnerId={owner_id}; Path=/</nowiki>

'''Response'''
<nowiki>
404 Not found
Content-Type : application/json; charset=UTF-8

{
"itemNotFound": {
"guid": "cca219c5-3e2b-481d-8e7f-7083064872ff",
"message": "Resource not found",
"code": 404,
"details": ""
}
}</nowiki>

=== Account has not been set ===
'''Request'''
<nowiki>
GET /orders/{orderId}/account/paymentInfo
Cookie: OwnerId={owner_id}; Path=/</nowiki>

'''Response'''
<nowiki>
404 Not found
Content-Type : application/json; charset=UTF-8

{
"itemNotFound": {
"guid": "9ae11205-0650-471a-9ed7-7642107011dc",
"message": "",
"code": 404,
"details": ""
}
}</nowiki>

=== Payment info has not been set ===
'''Request'''
<nowiki>
GET /orders/{orderId}/account/paymentInfo
Cookie: OwnerId={owner_id}; Path=/</nowiki>

'''Response'''
<nowiki>
404 Not found
Content-Type : application/json; charset=UTF-8

{
"itemNotFound": {
"guid": "9ae11205-0650-471a-9ed7-7642107011dc",
"message": "",
"code": 404,
"details": ""
}
}</nowiki>

== See also ==
* [[Orders|Orders API]]
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Ordering API]]

Accounts-accountId-os-security-group-rules-ruleId:DELETE

2015-04-20T16:53:54Z

Jerry.dimitrov:

This operation will delete a firewall group rule.

='''DELETE''' /accounts/''{accountId}''/os-security-group-rules/''{ruleId}''=
This operation will delete a firewall group rule.

== Parameters ==
; accountId - ''string''
: The selected account Id.

; ruleId - ''string''
: The unique firewall group rule identifier.

== Response Codes ==
; Success:
:''HTTP/1.1 204 No Content''
; Failure:
:''HTTP/1.1 401 Unauthorized'' - This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.
:''HTTP/1.1 404 Not Found'' - The resource does not exist.

== Examples ==

'''Successfully delete the specified firewall group rule'''
:'''DELETE''' {{APIBaseURL}}/accounts/{accountId}/os-security-group-rules/{firewall_group_rule_id}

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''Response Code:''
<pre>HTTP/1.1 204 No Content</pre>

'''Failure while trying to delete a non-existent firewall group rule'''
:'''DELETE''' {{APIBaseURL}}/accounts/{accountId}/os-security-group-rules/{fake_firewall_group_rule_id}

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''Response Code:''
<pre>HTTP/1.1 404 Not Found</pre>

'''Failure while trying to make unauthorized access'''
:'''DELETE''' {{APIBaseURL}}/accounts/{accountId}/os-security-group-rules/{firewall_group_rule_id}

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded fake_authentication_string

''Response Code:''
<pre>HTTP/1.1 401 Unauthorized</pre>

''Response Body:''
401 Unauthorized
This server could not verify that you are authorized to
access the document you requested. Either you supplied the
wrong credentials (e.g., bad password), or your browser
does not understand how to supply the credentials required.

'''Failure while trying to pass invalid account number'''
:'''DELETE''' {{APIBaseURL}}/accounts/fakeId/os-security-group-rules/{firewall_group_rule_id}

''Response Code:''
<pre>HTTP/1.1 404 Not Found</pre>

''Response Body:''
<nowiki>
{
"itemNotFound" : {
"message": "Resource not found",
"code": 404,
"details": "",
"errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
}
}</nowiki>

== Alternative URI /accounts/os-security-group-rules/{ruleId} ==
An alternative way to execute this call is to omit the ''accountId'' portion of the URI. In this case the system assumes the request is executed for the account identified in the [[Authentication|authorization header]].

<code>DELETE /accounts/os-security-group-rules/{ruleId}</code>

[[Category:Hostway API]]
[[Category:FlexCloud Server API]]

Accounts-accountId-os-security-groups-groupId:DELETE

2015-04-20T16:52:05Z

Jerry.dimitrov:

This operation will delete the specified firewall group.

='''DELETE''' /accounts/''{accountId}''/os-security-groups/''{groupId}''=
This operation will delete the specified firewall group.

== Parameters ==
; accountId - ''string''
: The selected account Id.

; groupId - ''string''
: The unique identifier of the firewall group.

== Response Codes ==
; Success:
:''HTTP/1.1 204 No Content''
; Failure:
:''HTTP/1.1 401 Unauthorized'' - This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.
:''HTTP/1.1 404 Not Found'' - The resource does not exist.

== Examples ==

'''Successfully delete the specified firewall group'''
:'''DELETE''' {{APIBaseURL}}/accounts/{accountId}/os-security-groups/group2012May11_OK30Zs7Ju

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''Response Code:''
<pre>HTTP/1.1 204 No Content</pre>

'''Failure while trying to make unauthorized access'''
:'''DELETE''' {{APIBaseURL}}/accounts/{accountId}/os-security-groups/group2012May11_OK30Zs7Ju

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded fake_authentication_string

''Response Code:''
<pre>HTTP/1.1 401 Unauthorized</pre>

''Response Body:''
401 Unauthorized
This server could not verify that you are authorized to
access the document you requested. Either you supplied the
wrong credentials (e.g., bad password), or your browser
does not understand how to supply the credentials required.

'''Failure while trying to delete a non-existent firewall group'''
:'''DELETE''' {{APIBaseURL}}/accounts/{accountId}/os-security-groups/{fake_firewall_group_id}

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''Response Code:''
<pre>HTTP/1.1 404 Not Found</pre>

'''Failure while trying to pass invalid account number'''
:'''DELETE''' {{APIBaseURL}}/accounts/fakeId/os-security-groups/group2012May11_OK30Zs7Ju

''Response Code:''
<pre>HTTP/1.1 404 Not Found</pre>

''Response Body:''
<nowiki>
{
"itemNotFound" : {
"message": "Resource not found",
"code": 404,
"details": "",
"errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
}
}</nowiki>

== Alternative URI /accounts/os-security-groups/{groupId} ==
An alternative way to execute this call is to omit the ''accountId'' portion of the URI. In this case the system assumes the request is executed for the account identified in the [[Authentication|authorization header]].

<code>DELETE /accounts/os-security-groups/{groupId}</code>

[[Category:Hostway API]]
[[Category:FlexCloud Server API]]

Accounts-accountId-os-security-groups-groupId:PUT

2015-04-20T16:51:06Z

Jerry.dimitrov:

This operation will update displayname and/or descriptin of the specified firewall group.

='''PUT''' /accounts/''{accountId}''/os-security-groups/''{groupId}''=

== Parameters ==
; accountId - ''string''
: The selected account Id.

; groupId - ''string''
: The unique identifier of the firewall group.

== Request==
=== JSON ===
<nowiki>
{
"securityGroup" : {
"displayName" : "{firewall_group_display_name}",
"description" : "{firewall_group_description}",
}
} </nowiki>

== Response ==
=== JSON ===
<nowiki>
{
"securityGroup" : {
"displayName" : "{firewall_group_display_name}",
"description" : "{firewall_group_description}",
"links" : [
{
"href" : "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/os-security-groups/{groupId}/",
"rel" : "self"
}
],
"rules" : [
{
"fromPort" : "{start_port}",
"toPort" : "{end_port}",
"protocol" : "{ip_protocol}",
"cidr": "0.0.0.0/0",
"id" : "145"
},
{
"fromPort" : "{start_port}",
"toPort" : "{end_port}",
"protocol" : "{ip_protocol}",
"cidr": "127.0.0.1/0",
"id" : "169"
}
],
"servers" : ["{server_id}"],
"accountNumber" : "{user_account_number}",
"id" : "{firewall_group_id}"
}
}</nowiki>

== Response Codes ==
; Success
: ''HTTP/1.1 200 OK''

; Failure
: ''HTTP/1.1 401 Unauthorized'' : This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.
:''HTTP/1.1 404 Not Found'' - The resource does not exist.

== Examples ==
'''Successfully edit details for specified firewall group'''
:'''PUT''' {{APIBaseURL}}/accounts/{accountId}/os-security-groups/group2012May11_OK30Zs7Ju

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''Request Body:''
<nowiki>
{
"securityGroup" : {
"displayName": "New display name",
"description": "New description",
}</nowiki>

''Response Code:''
<pre>HTTP/1.1 200 OK</pre>

''Response Body:''
<nowiki>
{
"securityGroup" : {
"displayName": "New display name",
"description": "New description.",
"links": [
{
"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/os-security-groups/group2012May11_OK30Zs7Ju/",
"rel": "self"
}
],
"rules": [
{
'toPort': 1111,
'fromPort': 1111,
'protocol': 'TCP',
'id': 145,
'cidr': '0.0.0.0/0'
},
{
'toPort': 80,
'fromPort': 80,
'protocol': 'tcp',
'id': 196,
'cidr': '127.0.0.1/24'
}
],
"id": "group2012May11_OK30Zs7Ju",
"accountNumber": "test_account_120761",
"servers": ["test-server-0003"]
}
}</nowiki>

'''Failure while trying to edit a firewall group that does not exist'''
:'''PUT''' {{APIBaseURL}}/accounts/{accountId}/os-security-groups/{fake_firewall_group_id}

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''Response Code:''
<pre>HTTP/1.1 404 Not Found</pre>

''Response Body:''
{
"itemNotFound":
{
"message": "Resource not found",
"code": 404,
"details": "",
"errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
}
}

[[Category:Hostway API]]
[[Category:FlexCloud Server API]]

Accounts-accountId-os-security-groups-groupId:GET

2015-04-20T16:50:01Z

Jerry.dimitrov:

This operation will list the details for the specified firewall group.

='''GET''' /accounts/''{accountId}''/os-security-groups/''{groupId}''=
This operation will list the details for the specified firewall group.

== Parameters ==
; accountId - ''string''
: The selected account Id.

; groupId - ''string''
: The unique identifier of the firewall group.

== Response ==
=== JSON ===
<nowiki>
{
"securityGroup" : {
"displayName" : "{firewall_group_display_name}",
"description" : "{firewall_group_description}",
"links" : [
{
"href" : "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/os-security-groups/{groupId}/",
"rel" : "self"
}
],
"rules" : [
{
"fromPort" : "{start_port}",
"toPort" : "{end_port}",
"protocol" : "{ip_protocol}",
"cidr": "0.0.0.0/0",
"id" : "145"
},
{
"fromPort" : "{start_port}",
"toPort" : "{end_port}",
"protocol" : "{ip_protocol}",
"cidr": "127.0.0.1/0",
"id" : "169"
}
],
"servers" : ["{server_id}"],
"accountNumber" : "{user_account_number}",
"id" : "{firewall_group_id}"
}
}</nowiki>

====securityGroup====
; displayName - ''string''
: The display name of the firewall group.

; description - ''string''
: Text describing the firewall group.

; links - ''list''
: [[Hypermedia]] for this resource.

; rules - ''list''
: List describing all defined security rules for the group.

; servers - ''list''
: List of server ids this firewall group is assigned to.

; accountNumber - ''string''
: Identifies an account that owns the firewall group.

; id - ''string''
: The id of this firewall group.*(Unique identifier for this firewall group.)

== Response Codes ==
; Success
: ''HTTP/1.1 200 OK''

; Failure
: ''HTTP/1.1 401 Unauthorized'' : This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.
:''HTTP/1.1 404 Not Found'' - The resource does not exist.

== Examples ==
'''Successfully list details for specified firewall group'''
:'''GET''' {{APIBaseURL}}/accounts/{accountId}/os-security-groups/group2012May11_OK30Zs7Ju

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''Response Code:''
<pre>HTTP/1.1 200 OK</pre>

''Response Body:''
<nowiki>
{
"securityGroup" : {
"displayName": "Test Firewall Group 1",
"description": "Test firewall group 1 description.",
"links": [
{
"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/os-security-groups/group2012May11_OK30Zs7Ju/",
"rel": "self"
}
],
"rules": [
{
'toPort': 1111,
'fromPort': 1111,
'protocol': 'TCP',
'id': 145,
'cidr': '0.0.0.0/0'
},
{
'toPort': 80,
'fromPort': 80,
'protocol': 'TCP',
'id': 196,
'cidr': '127.0.0.1/24'
}
],
"id": "group2012May11_OK30Zs7Ju",
"accountNumber": "test_account_120761",
"servers": ["test-server-0003"]
}
}</nowiki>

'''Failure while trying to request details for a firewall group that does not exist'''
:'''GET''' {{APIBaseURL}}/accounts/{accountId}/os-security-groups/{fake_firewall_group_id}

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''Response Code:''
<pre>HTTP/1.1 404 Not Found</pre>

''Response Body:''
{
"itemNotFound":
{
"message": "Resource not found",
"code": 404,
"details": "",
"errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
}
}

'''Failure while trying to make unauthorized access'''
:'''GET''' {{APIBaseURL}}/accounts/{accountId}/os-security-groups/group2012May11_OK30Zs7Ju

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded fake_authentication_string

''Response Code:''
<pre>HTTP/1.1 401 Unauthorized</pre>

''Response Body:''
401 Unauthorized
This server could not verify that you are authorized to
access the document you requested. Either you supplied the
wrong credentials (e.g., bad password), or your browser
does not understand how to supply the credentials required.

'''Failure while trying to pass invalid account number'''
:'''GET''' {{APIBaseURL}}/accounts/fakeId/os-security-groups/group2012May11_OK30Zs7Ju

''Response Code:''
<pre>HTTP/1.1 404 Not Found</pre>

''Response Body:''
<nowiki>
{
"itemNotFound" : {
"message": "Resource not found",
"code": 404,
"details": "",
"errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
}
}</nowiki>

== Alternative URI /accounts/os-security-groups/{groupId} ==
An alternative way to execute this call is to omit the ''accountId'' portion of the URI. In this case the system assumes the request is executed for the account identified in the [[Authentication|authorization header]].

<code>GET /accounts/os-security-groups/{groupId}</code>

[[Category:Hostway API]]
[[Category:FlexCloud Server API]]

Accounts-accountId-os-security-groups:POST

2015-04-20T16:48:21Z

Jerry.dimitrov:

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.

='''POST''' /accounts/''{accountId}''/os-security-groups=
This operation will create a new firewall group.

== Request ==
=== Parameters ===
; accountId - ''string''
: The selected account Id.

=== JSON ===
<nowiki>
{
"securityGroup" : {
"displayName" : "{firewall_group_display_name}",
"description" : "{firewall_group_description}"
}
}</nowiki>

====securityGroup====
; displayName - ''string''
: Display name for this firewall group.

; description - ''string''
: Descriptive information for this firewall group.

== Response ==
=== JSON ===
<nowiki>
{
"securityGroup" : {
"displayName": "{firewall_group_display_name}",
"description": "{firewall_group_description}",
"links": [
{
"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/os-security-groups/{firewall_group_id}/",
"rel": "self"
}
],
"rules": [],
"id": "{firewall_group_id}",
"accountNumber": "{user_account_number}",
"servers": []
}
}</nowiki>

====securityGroup====
; displayName - ''string''
: Display name for this firewall group.

; description - ''string''
: Descriptive information for this firewall group.

; links - ''list''
: [[Hypermedia]] for this resource.

; rules - ''list''
: List of all defined security rules for the group.

; id - ''string''
: The id of the firewall group.*(Unique identifier for this firewall group.)

; accountNumber - ''string''
: The account number this firewall group resource belongs to.

; servers - ''list''
: List of server IDs this security group is assigned to.

== Response Codes ==
; Success
: ''HTTP/1.1 201 Created''

; Failure
: ''HTTP/1.1 400 Bad Request''
: ''HTTP/1.1 401 Unauthorized'' : This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.
: ''HTTP/1.1 409 Conflict'' - The resource already exists.

== Examples ==
'''Successfully create a new firewall group'''
:'''POST''' {{APIBaseURL}}/accounts/{accountId}/os-security-groups

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''Request Body:''
<nowiki>
{
"securityGroup" : {
"displayName" : "Test Firewall Group",
"description" : "Test firewall group description."
}
} </nowiki>

''Response Code:''
<pre>HTTP/1.1 201 Created</pre>

''Response Body:''
<nowiki>
{
"securityGroup" : {
"displayName": "Test Firewall Group",
"description": "Test firewall group description.",
"links": [
{
"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/os-security-groups/group2012May11_OK30Zs7Ju/",
"rel": "self"
}
],
"rules": [],
"id": "group2012May11_OK30Zs7Ju",
"accountNumber": "test_account_120761",
"servers": []
}
}</nowiki>

'''Failure while trying to create a new firewall group with invalid data'''
:'''POST''' {{APIBaseURL}}/accounts/{accountId}/os-security-groups

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''Request Body:''
{
Empty
}

''Response Code:''
<pre>HTTP/1.1 400 Bad Request</pre>

''Response Body:''
<nowiki>
{
"badRequest" : {
"message": "Invalid",
"code": 400,
"details": "",
"errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
}
}</nowiki>

'''Failure while trying to create a new firewall group with an already existing firewall group display name'''
:'''POST''' {{APIBaseURL}}/accounts/{accountId}/os-security-groups

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''Request Body:''
<nowiki>
{
"securityGroup" : {
"displayName" : "Test Firewall Group",
"description" : "Test firewall group description."
}
}</nowiki>

''Response Code:''
<pre>HTTP/1.1 409 Conflict</pre>

''Response Body:''
<nowiki>
{
"computeFault" : {
"message": "GroupNameError",
"code": 400,
"details": "Display name in use",
"errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
}
}</nowiki>

'''Failure while trying to make unauthorized access'''
:'''POST''' {{APIBaseURL}}/accounts/{accountId}/os-security-groups

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded fake_authentication_string

''Response Code:''
<pre>HTTP/1.1 401 Unauthorized</pre>

''Response Body:''
401 Unauthorized
This server could not verify that you are authorized to
access the document you requested. Either you supplied the
wrong credentials (e.g., bad password), or your browser
does not understand how to supply the credentials required.

'''Failure while trying to pass invalid account number'''
:'''POST''' {{APIBaseURL}}/accounts/fakeId/os-security-groups

''Response Code:''
<pre>HTTP/1.1 404 Not Found</pre>

''Response Body:''
<nowiki>
{
"itemNotFound" : {
"message": "Resource not found",
"code": 404,
"details": "",
"errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
}
}</nowiki>

== Alternative URI /accounts/os-security-groups ==
An alternative way to execute this call is to omit the ''accountId'' portion of the URI. In this case the system assumes the request is executed for the account identified in the [[Authentication|authorization header]].

<code>POST /accounts/os-security-groups</code>

[[Category:Hostway API]]
[[Category:FlexCloud Server API]]

Accounts-accountId-os-security-groups:GET

2015-04-20T16:46:20Z

Jerry.dimitrov:

This operation lists existing firewall groups.

='''GET''' /accounts/''{accountId}''/os-security-groups=
This operation lists existing firewall groups.

== Request ==
==== Request Parameters ====
; accountId - ''string''
: The selected account Id.

== Response ==
=== JSON ===
<nowiki>
{
"securityGroups" : [
{
"displayName" : "{firewall_group_display_name}",
"description" : "{firewall_group_description}",
"links" : [
{
"href" : "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/os-security-groups/{firewall_group_id}/",
"rel" : "self"
}
],
"rules" : [
{
"fromPort" : {start_port},
"toPort" : {end_port},
"protocol" : "{ip_protocol}",
"cidr": "0.0.0.0/0",
"id" : "145"
}
]
"servers" : ["{server_id}"],
"accountNumber" : "{user_account_number}",
"Id" : "{firewall_group_id}"
}
]
}</nowiki>

====security_groups====
; displayName - ''string''
: The display name of the firewall group.

; description - ''string''
: Text describing the firewall group.

; links - ''list''
: [[Hypermedia]] for this resource.

; rules - ''list''
: List describing all defined security rules for the group.

; fault - ''dictionary''
: Might hold a fault information for the firewall group.

; servers - ''list''
: List of server ids this firewall group is assigned to.

; accountNumber - ''string''
: Identifies an account that owns the firewall group.

; id - ''string''
: The id of this firewall group.*(Unique identifier for this firewall group.)

== Response Codes ==
; Success
: ''HTTP/1.1 200 OK''

; Failure
: ''HTTP/1.1 401 Unauthorized'' : This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.
: ''HTTP/1.1 404 Not Found'' - The resource does not exist.

== Examples ==
'''Successfully list firewall groups'''
:'''GET''' {{APIBaseURL}}/accounts/{accountId}/os-security-groups

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''Response Code:''
<pre>HTTP/1.1 200 OK</pre>

''Response Body:''
<nowiki>
{
"securityGroup" : [
{
"displayName": "Test Firewall Group 1",
"description": "Test firewall group 1 description.",
"links": [
{
"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/os-security-groups/group2012May11_OK30Zs7Ju/",
"rel": "self"
}
],
"rules": [
{
'toPort': 1111,
'fromPort': 1111,
'protocol': 'TCP',
'id': 145,
'cidr': '0.0.0.0/0'
},
{
'toPort': 80,
'fromPort': 80,
'protocol': 'TCP',
'id': 196,
'cidr': '127.0.0.1/24'
}
],
"id": "group2012May11_OK30Zs7Ju",
"accountNumber": "test_account_120761",
"servers": ["test-server-0003"]
},
{
"displayName": "Test Firewall Group",
"description": "Test firewall group description.",
"links": [
{
"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/os-security-groups/group2012Apr30_9J5qDwOIo/",
"rel": "self"
}
],
"rules": [
{
'toPort': 3389,
'fromPort': 3389,
'protocol': 'tcp',
'id': 116,
'cidr': '0.0.0.0/0'
},
{
'toPort': 8443,
'fromPort': 8443,
'protocol': 'tcp',
'id': 117,
'cidr': '0.0.0.0/0'
},
{
'toPort': 22,
'fromPort': 22,
'protocol': 'tcp',
'id': 118,
'cidr': '0.0.0.0/0'
}
],
"id": "group2012Apr30_9J5qDwOIo",
"accountNumber": "test_account_901265",
"servers": ["test-server-0011", "test-server-0024"]
}
}
}</nowiki>

'''Failure while trying to make unauthorized access'''
:'''POST''' {{APIBaseURL}}/accounts/{accountId}/os-security-groups

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded fake_authentication_string

''Response Code:''
<pre>HTTP/1.1 401 Unauthorized</pre>

''Response Body:''
401 Unauthorized
This server could not verify that you are authorized to
access the document you requested. Either you supplied the
wrong credentials (e.g., bad password), or your browser
does not understand how to supply the credentials required.

'''Failure while trying to pass invalid account number'''
:'''POST''' {{APIBaseURL}}/accounts/fakeId/os-security-groups

''Response Code:''
<pre>HTTP/1.1 404 Not Found</pre>

''Response Body:''
<nowiki>
{
"itemNotFound" : {
"message": "Resource not found",
"code": 404,
"details": "",
"errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
}
}</nowiki>

== Alternative URI /accounts/os-security-groups ==
An alternative way to execute this call is to omit the ''accountId'' portion of the URI. In this case the system assumes the request is executed for the account identified in the [[Authentication|authorization header]].

<code>GET /accounts/os-security-groups</code>

[[Category:Hostway API]]
[[Category:FlexCloud Server API]]

Accounts-account-email-domain-usernames-mailboxName-mailbox-action:POST

2014-12-04T14:18:35Z

Jerry.dimitrov: Replaced content with "{{resetPassword|| a|resource=mailbox|base=/accounts/{account}|base_example=/accounts/account123}}"

{{resetPassword|| a|resource=mailbox|base=/accounts/{account}|base_example=/accounts/account123}}

Email-domain-usernames-mailboxName-mailbox-action:POST

2014-12-04T14:14:47Z

Jerry.dimitrov: Replaced content with "{{resetPassword|| a|resource=mailbox|base=|base_example=}}"

Template:ResetPassword

2014-12-04T14:13:39Z

Jerry.dimitrov:

= POST {{{base}}}/email/{domain}/usernames/{mailboxName}/{{{resource}}}/action =
Apply an action on{{{2}}}{{{1}}} mailbox e.g. '''reset password'''

__TOC__

== Request ==
<code>POST {{{base}}}/email/{domain}/usernames/{mailboxName}/{{{resource}}}/action</code>

==== Request Parameters ====
; account - ''string''
: The user account owning the domain and the{{{1}}} mailboxes
; domain - ''string''
: The specific domain for which the call will retrieve the list
; maiboxName - ''string''
: The name of the{{{1}}} mailbox.

=== Request Headers ===
; Content-Type
: Required. Set this header to <code>application/json; charset=UTF-8</code>

=== Request Body ===
<nowiki>
{
"action": "resetPassword",
"actionData": {
"secretQuestionsAnswers": {"{tk}": "{answer}"},
"password": "{password}"
}
}
</nowiki>

; action - ''string''
: The action that should be performed. Allowed values are:
:: '''resetPassword''' - Reset the password of{{{2}}}{{{1}}} mailbox.

; actionData - ''dictionary (Required)''
: Data to be send with the action.

; secretQuestionsAnswers - ''dictionary (Required)''
: Dictionary of key/value pairs, each of which represents '''secret question text key/answer''' pair.

; tk - ''string'' (Required)
: The text key for the secret question. There should be no duplicate text keys per{{{1}}} mailbox.

; answer - ''string'' (Required)
: The answer in plain-text - must be at least two characters.
{{:Accounts-account-email-domain-usernames-mailboxName-mailbox:PUT}}

== Response ==

=== Expected Response Codes ===
; 204 No Content
: Success

; 400 Bad Request
: The supplied action or the supplied data is invalid.

; 404 Not Found
: The resource does not exist.

; 409 Conflict
: Validation of the secret answer failed.

== Examples ==

=== Request password reset of{{{2}}}{{{1}}} mailbox ===
'''Request'''
<nowiki>
POST </nowiki>{{{base_example}}}<nowiki>/email/test.com/usernames/mailbox123/</nowiki>{{{resource}}}<nowiki>/action
Content-Type: application/json; Charset=UTF-8

{
"action": "resetPassword",
"actionData": {
"secretQuestionsAnswers": {"tk1": "answer123"},
"password": "pWord123$"
}
</nowiki>

'''Response'''
<nowiki>
204 No Content
</nowiki>

=== Request password reset of{{{2}}}{{{1}}} mailbox with wrong answer ===
'''Request'''
<nowiki>
POST </nowiki>{{{base_example}}}<nowiki>/email/test.com/usernames/mailbox123/</nowiki>{{{resource}}}<nowiki>/action
Content-Type: application/json; Charset=UTF-8

{
"action": "resetPassword",
"actionData": {
"secretQuestionsAnswersList": {"tk1": "wrongAnswer"},
"password": "pWord123$"
}
</nowiki>

'''Response'''
<nowiki>
409 Conflict

{
"conflict": {
"message": "Invalid secret questions and answers provided",
"code": 409,
}
}
</nowiki>

== See also ==
* [[Email API|Email API]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Email API]]

Email-domain-usernames-mailboxName-exchange-action:POST

2014-12-04T14:09:29Z

Jerry.dimitrov: Created page with "{{resetPassword| exchange||resource=exchange|base=|base_example=}}"

{{resetPassword| exchange||resource=exchange|base=|base_example=}}

Accounts-account-email-domain-usernames-mailboxName-exchange-action:POST

2014-12-04T14:04:51Z

Jerry.dimitrov: Created page with "{{resetPassword| exchange||resource=exchange|base=/accounts/{account}|base_example=/accounts/account123}}"

{{resetPassword| exchange||resource=exchange|base=/accounts/{account}|base_example=/accounts/account123}}

Email-domain-usernames-mailboxName-secrets:PUT

2014-11-26T14:28:08Z

Jerry.dimitrov: /* Status Code */

= PUT /email/{domain}/usernames/{mailboxName}/secrets =
Set or update all secret questions and answers for mailbox(alias).
__TOC__

== Request ==
<code>PUT /email/{domain}/usernames/{mailboxName}/secrets</code>

==== Request Parameters ====
; domain - ''string''
: The specific mailbox domain
; maiboxName - ''string''
: The name of the mailbox

=== Request Body ===
<nowiki>
{
"{tk}": "{answer}",
"{tk}": "{answer}",
...
}
</nowiki>

==== Parameters ====
; tk - ''string'' (Required)
: The text key for the secret question. There should be no duplicate text keys per mailbox.

; answer - ''string'' (Required)
: The answer in plain-text - must be at least two characters.
=== Request Headers ===
{{Authorization}}

; Content-Type
: Required. Set this header to <code>application/json; charset=UTF-8</code>

== Response ==

=== Status Code ===
; 204 No Content
: Success

; 400 Bad Request
: The format of the request body is invalid or the number of the secret questions and answers pairs in the request is lower then the [[Email-secretQuestionSettings:GET|required minimum]].

; 401 Unauthorized
: The supplied credentials are invalid.

; 403 Forbidden
: The authorized user does not have permissions for this operation.

; 404 Not Found
: The domain name, mailbox or account does not exist.

== Examples ==

=== Success scenario ===
'''Request'''
<nowiki>
PUT /email/test.com/usernames/test-mailbox/secrets

{
"tk1": "answer1",
"tk2": "answer2",
"tk3": "answer3"
}
</nowiki>

'''Response'''
<nowiki>
204 No Content
</nowiki>

=== Set only two secret questions and answers, when the required minimum is three ===
'''Request'''
<nowiki>
PUT /email/test.com/usernames/test-mailbox/secrets

{
"tk1": "answer1",
"tk2": "answer2"
}
</nowiki>

'''Response'''
<nowiki>
400 Bad Request

"details": {"": "Shorter than minimum length 3"}
</nowiki>

== See also ==
* [[Email API|Email API]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Email API]]

Accounts-account-email-domain-usernames-mailboxName-secrets:PUT

2014-11-26T14:27:50Z

Jerry.dimitrov: /* Status Code */

= PUT /accounts/{account}/email/{domain}/usernames/{maiboxName}/secrets =
Set or update all secret questions and answers for mailbox(alias).
__TOC__

== Request ==
<code>PUT /accounts/{account}/email/{domain}/usernames/{maiboxName}/secrets</code>

==== Request Parameters ====
; account - ''string''
: The user account owning the domain and the mailboxes
; domain - ''string''
: The specific mailbox domain
; maiboxName - ''string''
: The name of the mailbox

=== Request Body ===
<nowiki>
{
"{tk}": "{answer}",
"{tk}": "{answer}",
...
}
</nowiki>

==== Parameters ====
<onlyinclude>
; tk - ''string'' (Required)
: The text key for the secret question. There should be no duplicate text keys per mailbox.

; answer - ''string'' (Required)
: The answer in plain-text - must be at least two characters.
</onlyinclude>
=== Request Headers ===
{{Authorization}}

; Content-Type
: Required. Set this header to <code>application/json; charset=UTF-8</code>

== Response ==

=== Status Code ===
; 204 No Content
: Success

; 400 Bad Request
: The format of the request body is invalid or the number of the secret questions and answers pairs in the request is lower then the [[Email-secretQuestionSettings:GET|required minimum]].

; 401 Unauthorized
: The supplied credentials are invalid.

; 403 Forbidden
: The authorized user does not have permissions for this operation.

; 404 Not Found
: The domain name, mailbox or account does not exist.

== Examples ==

=== Success scenario ===
'''Request'''
<nowiki>
PUT /accounts/test-account123/email/test.com/usernames/test-mailbox/secrets

{
"tk1": "answer1",
"tk2": "answer2",
"tk3": "answer3"
}
</nowiki>

'''Response'''
<nowiki>
204 No Content
</nowiki>

=== Set only two secret questions and answers, when the minimum required is three ===
'''Request'''
<nowiki>
PUT /accounts/test-account123/email/test.com/usernames/test-mailbox/secrets

{
"tk1": "answer1",
"tk2": "answer2"
}
</nowiki>

'''Response'''
<nowiki>
400 Bad Request

"details": {"": "Shorter than minimum length 3"}
</nowiki>

== See also ==
* [[Email API|Email API]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Email API]]

Accounts-accountId:GET

2014-11-14T13:13:03Z

Jerry.dimitrov: /* Parameters */

= GET /accounts/''{accountId}'' =
Get details about an account.
__TOC__
== Request ==
<code>GET /accounts/''{accountId}''</code>

==== Parameters ====
; accountId - ''string''
: The Id of the account.

=== URI Parameters ===
None.

=== Request Headers ===
{{Authorization}}

== Response ==

=== Status Code ===
;200 OK
: Success.

;403 Forbidden
: Forbidden access to '''closed''' and '''suspended''' accounts by a user not authorized for such access.

;404 Not Found
: The account Id was not found.

=== Response Body ===
<nowiki>
{
"accountNumber": "{accountId}",
"createdDate": "{createdDate}",
"currency": "{currency}",
"status": "open",
"paymentInfo": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{account-number}/paymentInfo", "rel": "related"}
],
"products": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{account-number}/products", "rel": "related"}
],
"exchange": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{account-number}/exchange", "rel": "related"}
],
"dedicatedServers": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{account-number}/dedicatedServers", "rel": "related"}
],
"contacts": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{account-number}/contacts", "rel": "related"}
],
"email": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{account-number}/email", "rel": "related"}
],
"domains": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{account-number}/domains", "rel": "related"}
],
"attributes": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{account-number}/attributes", "rel": "related"}
],
"flexcloud": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{account-number}/flexcloud", "rel": "related"}
],
"users": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{account-number}/users", "rel": "related"}
],
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{account-number}/", "rel": "self"}
]
}
</nowiki>

==== Parameters ====
; accountNumber - ''string''
: The Id of the account

; createdDate - ''date''
: The date account was created in format Y-m-d

; currency - ''string''
: An ISO-4217[http://www.iso.org/iso/home/standards/currency_codes.htm] currency code assigned to the account.

; status - ''string''
: status of the account. Valid values are '''open''', '''closed''' or '''suspended'''. Accounts with certain status may not be accessible by regular users.

; paymentInfo - ''list''
: ''(OPTIONAL)''
: [[Hypermedia]] to a resource of the payment instruments associated with the account.

; users - ''list''
: ''(OPTIONAL)''
: [[Hypermedia]] to a resource of the users associated with the account.

; products - ''list''
: ''(OPTIONAL)''
: [[Hypermedia]] to a resource containing all the products of the account. This value will appear depending on the user's access rights.

; dedicatedServers - ''list''
: ''(OPTIONAL)''
: [[Hypermedia]] to a resource containing all the dedicated server products of the account.

; exchange - ''list''
: ''(OPTIONAL)''
: [[Hypermedia]] to a resource containing all the Exchange domains of the account.

; contacts - ''list''
: ''(OPTIONAL)''
: [[Hypermedia]] to a resource handling the contact details of the account.

; email - ''list''
: ''(OPTIONAL)''
: [[Hypermedia]] to a resource containing all the email domains of the account.

; domains - ''list''
: ''(OPTIONAL)''
: [[Hypermedia]] linking to the domain name management of the account.

; attributes - ''list''
: ''(OPTIONAL)''
: [[Hypermedia]] to a partner attributes of the account.

; flexcloud - ''list''
: ''(OPTIONAL)''
: [[Hypermedia]] to the Flexcloud management of the account.

; links - ''list''
: [[Hypermedia]] for this resource. Links to self.

== Conditional Hypermedia ==
Hypermedia fields marked as optional will appear on the basis of the accessing user's permissions.

== Alternative with partner Id ==
As an alternative to using the account Id the client can use a partner-specific Id set via the account attribute [[Orders-orderId-account-attributes:PUT|partner_account_id]]. The response to this request is the same as the response to a request using the account Id.

<code>GET /partnerAccounts/''{partnerAccountId}''</code>

==== Parameters ====
; partnerAccountId - ''string''
: Partner account Id set via the [[Orders-orderId-account-attributes:PUT|partner_account_id]] attribute.

== See also ==
* [[Account|Account Management API]]
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Account Management API]]

Accounts:GET

2014-11-14T13:12:38Z

Jerry.dimitrov: /* Paginated request when more then one account is returned */

= GET /accounts =
Retrieves a list of all accounts authorized for access with the provided credentials.
__TOC__
== Request ==
<code>GET /accounts</code>

=== URI Parameters ===
; filterStatus - ''string''
: Optional. Only accounts with status matching the value of the parameter will be returned. Allowed values are '''pending''', '''open''', '''suspended''', '''closed'''.

; page - ''integer''
: Optional. Specifies which page should be displayed. Requires a pageSize parameter to also be provided.

; pageSize - ''integer''
: Optional. Specifies the number of entries to be displayed on a page. Default size is 100. Requires a page parameter to also be provided.

=== Request Headers ===
{{Authorization}}

== Response ==

=== Status Code ===
;200 OK
: Success

;400 Bad Request
:

; 401 Unauthorized
: The supplied credentials are invalid or do not provide permissions for this operation.

; 403 Forbidden
: Forbidden access to a user not authorized for such access.

; 415 Unsupported Media Type
: The Content-Type header was not specified or the specified type is not supported. Use application/json.

=== Response Body ===
<nowiki>
{
"list" : [{
"status" : "{status}",
"links" : [{
"href" : "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{account-number}/",
"rel" : "self"
}],
"accountNumber" : "{account-number}",
"createdDate" : "{created-date}",
"currency": "{currency}"
}],
"links" : [{
"href" : "</nowiki>{{APIBaseURL}}<nowiki>/accounts?pageSize={pageSize}&page={page}",
"rel" : "self"
},
{
"href" : "</nowiki>{{APIBaseURL}}<nowiki>/accounts?pageSize={pageSize}&page={page}",
"rel" : "next"
},
{
"href" : "</nowiki>{{APIBaseURL}}<nowiki>/accounts?pageSize={pageSize}&page={page}",
"rel" : "last"
}]
}
</nowiki>

==== Parameters ====
; list - ''list''
: A collection of dictionaries containing information about specific account

:; status - ''string''
:: Describes the status of the account. Valid values are '''pending''', '''open''', '''suspended''', '''closed'''

:; accountNumber - ''string''
:: The Id of the account

:; createdDate - ''date''
:: The date account was created in format Y-m-d

:; currency - ''string''
:: An ISO-4217[http://www.iso.org/iso/home/standards/currency_codes.htm] currency code assigned to the account.

:; links - ''list''
:: [[Hypermedia]] for this account resource. Links to the account.

; links - ''list''
: [[Hypermedia]] Link to self and other resources relevant to the account lists

== Examples ==

=== Listing current account only when provided credentials don't give elevated access ===
'''Request'''
<nowiki>
GET /accounts
</nowiki>

'''Response'''
<nowiki>
{
"list": [{
"status": "open",
"links": [{
"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/test-account/",
"rel": "self"
}],
"accountNumber": "test-account",
"createdDate": "2009-12-07",
"currency": "USD"
}],
"links": [{
"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts",
"rel": "self"
}]
}
</nowiki>

=== Paginated request when more then one account is returned ===
'''Request'''
<nowiki>
GET /accounts?pageSize=2&page=1
</nowiki>

'''Response'''
<nowiki>
{
"list" : [{
"status" : "open",
"links" : [{
"href" : "</nowiki>{{APIBaseURL}}<nowiki>/accounts/test-account-1/",
"rel" : "self"
}],
"accountNumber" : "test-account-1",
"createdDate": "2009-12-07",
"currency": "USD"
},
"status" : "closed",
"links" : [{
"href" : "</nowiki>{{APIBaseURL}}<nowiki>/accounts/test-account-2/",
"rel" : "self"
}],
"accountNumber" : "test-account-2",
"createdDate": "20012-11-01",
"currency": "CAD"
}],
"links" : [{
"href" : "</nowiki>{{APIBaseURL}}<nowiki>/accounts?pageSize=2&page=1",
"rel" : "self"
},
{
"href" : "</nowiki>{{APIBaseURL}}<nowiki>?pageSize=2&page=2",
"rel" : "next"
},
{
"href" : "</nowiki>{{APIBaseURL}}<nowiki>?pageSize=2&page=11637",
"rel" : "last"
}]
}
</nowiki>

== See also ==
* [[Account|Account Management API]]
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Account Management API]]

Orders-orderId-account-products:POST

2014-11-12T11:59:22Z

Jerry.dimitrov: /* Request Body */

= POST /orders/''{orderId}''/account/products =
Adds a new or existing Product to the Account's Order.

If, at the time the product is created, there is not yet an Account in the order, then this call will implicitly add a very rudimentary Account (containing only a default language & the currency of this product).

If there is already an Account in the order at the time this call is made, the currency of the specified product offering *must* match the currency of the Account.
__TOC__

== Request ==
<code>POST /orders/''{orderId}''/account/products</code>

=== Request Parameters ===
{{UriParameter-OrderId}}

=== URI Parameters ===
None.

=== Request Headers ===
; Content-Type
: Required. Set this header to <code>application/json; charset=UTF-8</code>

{{Cookie-OwnerId}}

=== Request Body ===
There are two possible formats. To add a new product that does not already exist:
<nowiki>
{
"offering": "</nowiki>{{APIBaseURL}}<nowiki>/productSpecifications/{productSpecificationId}/offerings/{productOfferingId}",
"promoCode": "{promoCode}",
"displayName": "My custom product name",
"partnerId": "PartnerId"
}</nowiki>

OR

To specify an existing product, use the following:
<nowiki>
{
"existingProductUrl": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/products/{productId}"
}</nowiki>

==== Parameters ====
; offering - ''string''
: Link to the [[Products#Product_Offerings|product catalog offering]] specifying the new product.
; promoCode - ''string'' (optional)
: A promotion code for the new product [[Orders#Promotion_Codes|promotion codes]].
; displayName - ''string'' (optional)
: A custom display name for the product.
; partnerId - ''string'' (optional)
: Partner id.
; existingProductUrl - ''string''
: Link to [[Account#Products_Management|an existing product]]. Only required when adding an existing product to the order.

=== Validation Rules ===
:# The product specification URL ( ''{{APIBaseURL}}/productSpecifications/{productSpecificationId}'' ) should point to an existing product.
:# The product offering currency should match the account currency or if no account is specified should be allowed for the franchise.
:# The product offering URL ( ''{{APIBaseURL}}/productSpecifications/{productSpecificationId}/offerings/{productOfferingId}'' ) should point to an existing product offering.
:# The product use type (public, internal, internal view only, etc.) should be allowed for the current user.
:# The product offering should be valid according to the back-end.
:# The account product URL ( ''{APIBaseURL}}/accounts/{accountId}/products/{productId}'' ) should point to an existing product that is open and belongs to the account.

== Response ==

=== Status Code ===
{| class="wikitable"
! Status Code
! Error Message
! Description
|-
| 201 Created
| -
| The operation was successfully completed.
|-
| rowspan="12"| 400 Bad Request
| POST data error
| Trying to create a product with invalid body.
|-
| Cannot add non-existent product \"fake\"
| Trying to create a product by passing fake offering.
|-
| Invalid offering URI
| Trying to create a product by passing invalid offering (missing currency, monthly cycle or productSpecifications)
|-
| The requested offering is invalid
| Trying to create a product with invalid monthly cycle (eg: 100)
|-
| Trying to add inconsistent currency: product {product} with FAKE while account uses USD
| Trying to create a product with currency, which does not match the account's currency
|-
| Currency FAKE not allowed for this franchise
| Trying to add a product with invalid for the franchise currency to an order for which no account has been set.
|-
| Trying to add Internal product {product} without authorization
| Trying to add product, which is internal, without the proper credentials.
|-
| Trying to add Internal View Only product {product}
| Trying to add product, which is internal view only, without the proper credentials.
|-
| Invalid product URI
| Tried to add an existing product with wrong existingProductUrl
|-
| The account of the order and the account of the product doesn't match
| Tried to add an existing product with account, which is different from the account of the order.
|-
| Product doesn't exist.
| Tried to add an existing product which does not exist
|-
| Cannot add a product that is not open.
| Tried to add an existing product that is not open.
|-
| 401 Unauthorized
| This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.
| The ''OwnerId'' cookie was not specified or is incorrect.
|-
| 403 Forbidden
| Unauthorized: Products failed permission check
| The client does not have permissions to add products.
|-
| 404 Not Found
| Resource not found
| The client is trying to add a product to non existing order.
|-
| 502 Bad Gateway
| -
| Unexpected backend response.
|}

=== Response Headers ===
; Location
: Returned with successful response. Contains the URI of the newly added product and the id of the product.

=== Response Body ===
==== Successful response ====
<nowiki>
201 Created
{
"productId": "00000148842a5f6448a61ce6007f000000010001",
"url" : "</nowiki>{{APIBaseURL}}<nowiki>/orders/0000014884293798c68eafa5007f000000010001/account/products/00000148842a5f6448a61ce6007f000000010001/"
}</nowiki>
: '''''Note:''''' The product Id will change once the order is provisioned.

==== Error responses ====
<nowiki>
400 Bad Request - trying to order product, which is internal, without the proper authorization.
{
"computeFault": {
"guid": "c940c886-5343-4a49-b728-0b94cbb1a3e9",
"message": "Trying to add Internal product {product} without authorization",
"code": 400,
"details": ""
}
}

400 Bad Request - trying to add a product, which is internal view only, such products cannot be added via the Public API.
{
"computeFault": {
"guid": "3ee2bd37-81ee-4a57-bd63-dc84705b3985",
"message": "Trying to add Internal View Only product {product}",
"code": 400,
"details": ""
}
}

400 Bad Request - trying to add a product without supplying the required attributes in the body.
{
"badRequest":{
"guid": "0f3e0435-21ac-43e5-acfd-ac33886fbe70",
"message": "POST data error",
"code": 400,
"details": {
"offering": "Required"
}
}
}

400 Bad Request - trying to add a product that does not exist.
{
"computeFault":{
"guid": "12cf7a72-3261-4c57-a82e-1f2f1c124d50",
"message": "Cannot add non-existent product \"fake\"",
"code": 400,
"details": ""
}
}

400 Bad Request - trying to add a product by supplying invalid offering URI (eg: "offering": "http://coreapi01.ote.chicago.hostway:8092/productSpecifications/core.plangroup.dedserver.plan4/offerings/")
{
"computeFault": {
"guid": "0ced627e-c9fc-4835-92da-1a4256165607",
"message": "Invalid offering URI",
"code": 400,
"details": ""
}
}

400 Bad Request - trying to add a product with invalid currency (case when account is set and the currency provided does not match the account's currency)
{
"computeFault": {
"guid": "742e193a-4667-47fd-a5ff-ec1f7788d459",
"message": "Trying to add inconsistent currency: product {product} with FAKE while account uses USD",
"code": 400,
"details": ""
}
}

400 Bad Request - trying to add a product with invalid for the franchise currency (case when an account is not set so the currency it is determined by the first added product, but the currency is not allowed for the franchise)
{
"computeFault": {
"guid": "3ee2bd37-81ee-4a57-bd63-dc84705b3985",
"message": "Currency FAKE not allowed for this franchise",
"code": 400,
"details": ""
}
}

400 Bad Request - trying to add a product with invalid month cycle (eg: 100)
{
"computeFault": {
"guid": "8165a0b2-80f5-436f-ab47-075d824144d9",
"message": "The requested offering is invalid",
"code": 400,
"details": ""
}
}

400 Bad Request - trying to add an existing product with invalid existingProductUrl
{
"computeFault": {
"guid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"message": "Invalid product URI",
"code": 400,
"details": ""
}
}

400 Bad Request - trying to add an existing product that belongs to account different from the account of the order.
{
"computeFault": {
"guid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"message": "The account of the order and the account of the product doesn't match",
"code": 400,
"details": ""
}
}

400 Bad Request - trying to add an existing product that does not exist
{
"computeFault": {
"guid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"message": "Product doesn't exist.",
"code": 400,
"details": ""
}
}

400 Bad Request - trying to add an existing product that is not open
{
"computeFault": {
"guid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"message": "Cannot add a product that is not open.",
"code": 400,
"details": ""
}
}</nowiki>

<nowiki>
401 Unauthorized

This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.</nowiki>

<nowiki>
403 Forbidden - the client does not have permission to add products.
{
"forbidden": {
"guid": "d336dd8e-bc52-44f3-b672-9aa2fac7fbf4",
"message": "Unauthorized: Products failed permission check",
"code": 403,
"details": ""
}
}</nowiki>

<nowiki>
404 Not Found - the order does not exist
{
"itemNotFound": {
"guid": "e1792d8a-5b0a-43ef-adf5-34a0710c8fc5",
"message": "Resource not found",
"code": 404,
"details": ""
}
}</nowiki>

<nowiki>
502 Bad Gateway - unexpected error from the backend.
{
"computeFault": {
"guid": "8ced5fe7-f6a9-4e8f-8700-cfc9fa15e6ce",
"timestamp": "2014-09-10 20:59:50",
"code": 502,
"errorRefId": "8ced5fe7-f6a9-4e8f-8700-cfc9fa15e6ce"
}
}</nowiki>

== See also ==
* [[Orders|Orders API]]
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Ordering API]]

Accounts-accountNumber-web-domainName-aliases-AliasDomainName:GET

2014-11-06T12:25:01Z

Jerry.dimitrov: /* Parameters */

= GET /accounts/{accountNumber}/web/{domainName}/aliases/{aliasDomainName} =
Returns details of the domain name alias.

__TOC__

== Request ==
<code>GET /accounts/{accountNumber}/web/{domainName}/aliases/{aliasDomainName}</code>

=== URI Parameters ===
; accountNumber - ''string''
: The user account to which the domain name and the domain name alias belong

; domainName - ''string''
: The target domain name (domain name under which the site is actually hosted)

; aliasDomainName - ''string''
: The domain name that will act as alias to the target domain

=== Request Headers ===
{{Authorization}}

== Response ==

=== Response Body ===
<nowiki>
{
billingStatus: "{billingStatus}",
"links": [
{
"href": "http://{server_name}/accounts/{accountNumber}/web/{domainName}/aliases/{aliasDomainName}",
"rel": "self"
}
]
}
</nowiki>

==== Parameters ====
:; billingStatus - ''string''
:: Current status of the domain name alias. Available values are '''pending''', '''open''', '''suspended''', '''close_pending''', '''closed'''
:: '''pending''' means that the alias is still in the process of being provisioned. '''open''', '''suspended''', '''closed''' and '''close_pending''' means the alias is fully provisioned and usable.

:; links - ''list''
:: [[Hypermedia|Hypermedia]] for this resource

=== Status Code ===
; 200 OK
: Success

; 401 Unauthorized
: The supplied credentials are invalid or do not provide permissions for this operation

; 403 Forbidden
: The authenticated user is not allowed to access this resource

; 404 Not Found
: The domain name or the domain name alias do not exist for the account

== Examples ==

=== Successful retrieving domain name alias ===
'''Request'''
<nowiki>
GET /accounts/test-account/web/test.com/aliases/test-alias.com
</nowiki>

'''Response'''
<nowiki>
{
billingStatus: "open",
"links": [
{
"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/test-account/web/test.com/aliases/test-alias.com",
"rel": "self"
}
]
}
</nowiki>

{{disqus}}
[[Category:Hostway API]]
[[Category:Web API]]