Accounts-account-dedicatedServers-server:GET
From Hostway API Documentation
GET /accounts/{accountId}/dedicatedServers/{serverId}
Retrieves specified dedicated server info.
Contents |
Request
GET /accounts/{accountId}/dedicatedServers/{serverId}
Request Parameters
- accountId - string
- The user account owning the dedicated server
- serverId - string
- The specified dedicated server Id
Request Headers
- Authorization - HTTP Authorization header [1]
- The Authentication credentials of the client application.
Response
Response Body
{
"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"
}
]
}
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
GET accounts/test-account123/dedicatedServers/test-srv-00132ff1
Response
{
"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"
}
]
}
See also
