Corinne.chui: 1 revision

2016-05-30T19:35:02Z

1 revision

Jerry.dimitrov: /* Parameters */

2016-04-08T16:26:59Z

Parameters

Mike.robski: 1 revision: Release 111

2015-09-18T17:15:14Z

1 revision: Release 111

Angel.dinev: /* Get specific dedicated server info */

2014-09-11T14:54:38Z

Get specific dedicated server info

New page

= 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}",
"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

; 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]]

@@ Line 23: / Line 23: @@
+{
    "dedicatedServerId": "{serverId}",
    "serverName": "{serverName}",
    "ipAddresses": [
+      {
@@ Line 45: / Line 46: @@
 ; serverName - ''string''
 : The name of the dedicated server
 ; ipAddresses - ''list''

Accounts-account-dedicatedServers-server:GET - Revision history

Corinne.chui: 1 revision

Jerry.dimitrov: /* Parameters */

Mike.robski: 1 revision: Release 111

Angel.dinev: /* Get specific dedicated server info */