Accounts-account-dedicatedServers-server-ipAddresses-ipaddress:GET
From Hostway API Documentation
Revision as of 07:14, 1 April 2015 by Velko.hristov (Talk)
GET /accounts/{account_number}/dedicatedServers/{serverId}/ipAddresses/{ipAddress}
Retrieves a list of the IP addresses of a dedicated server
Contents |
Request
GET /accounts/{account_number}/dedicatedServers/{serverId}/ipAddresses/{ipAddress}
Request Parameters
- account_number - string
- The user account owning the dedicated servers
- serverId - string
- The specified dedicated server Id
- ipAddress - string
- The IP address
Request Headers
- Authorization - HTTP Authorization header [1]
- The Authentication credentials of the client application.
Response
Response Body
{
"monitoring":[{"href": "{APIBaseURL}/accounts/{accountId}/dedicatedServers/{serverId}/ipAddresses/{ipAddress}/monitoring", "rel": "related"}],
"ipaddressid": "{ipAddress}",
"links": [{"href": "{APIBaseURL}/accounts/{accountId}/dedicatedServers/{serverId}/ipAddresses/{ipAddress}/", "rel": "self"}]
}
Parameters
- monitoring- list
- Hypermedia for a monitor call to the IP address product.
- ipaddressid - string
- The IP address
- links - list
- Hypermedia for this resource.
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.
- 405 Method not allowed
- The HTTP request method is not allowed.
Examples
Get a specific dedicated server IP
Request
GET /accounts/test-ng-809027223/dedicatedServers/test-ng-809027223-00000132ff10f8d8d63e8ce6000ac648/ipAddresses/11.10.13.11
Response
{
"monitoring":
[
{
"href": "http://coreapi01.ote.chicago.hostway:8092/accounts/test-ng-809027223/dedicatedServers/test-ng-809027223-00000132ff10f8d8d63e8ce6000ac648/ipAddresses/11.10.13.11/monitoring",
"rel": "related"
}
],
"ipaddressid": "11.10.13.11",
"links":
[
{
"href": "http://coreapi01.ote.chicago.hostway:8092/accounts/test-ng-809027223/dedicatedServers/test-ng-809027223-00000132ff10f8d8d63e8ce6000ac648/ipAddresses/11.10.13.11/",
"rel": "self"
}
]
}
See also
