Latest revision as of 13:36, 30 May 2016

[edit] GET /accounts/{accountNumber}/dedicatedServers/{serverId}/ipAddresses/{ipAddr}/monitoring/notificationGroups/{groupId}

This API call is deprecated!

Gets single notification group details info.

[edit] Request

GET /accounts/{accountNumber}/dedicatedServers/{serverId}/ipAddresses/{ipAddr}/monitoring/notificationGroups/{groupId}

[edit] Request Parameters

accountNumber - string

serverId - string

ipAddr - string

groupId - string

Id of the notification group

[edit] URI Parameters

None

[edit] Request Headers

Authorization

Specify the Authorization header when requesting details for an order that was already submitted. Follow the instructions for API Authentication.

[edit] Response

[edit] Status Code

200 OK

Success.

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.

404 Not Found

The resource requested is not found.

[edit] Response Body

{
   "notificationGroup": {
	"name": "{group-name}",
	"id": "{group-id}"
   },
   "links": [{
	"href": "{{APIBaseURL}}/accounts/{account-number}/dedicatedServers/{dedicated-server-id}/ipAddresses/{ip-address}/monitoring/notificationGroups/{group-id}",
	"rel": "self"
   }],
   "contacts": [{
	"href": "{{APIBaseURL}}/accounts/{account-number}/dedicatedServers/{dedicated-server-id}/ipAddresses/{ip-address}/monitoring/notificationGroups/{group-id}/contacts",
	"rel": "related"
}

[edit] Parameters

id - string

Unique identifier for this notification group.

name - string

Descriptive name for this notification group.

links - list

Hypermedia for this resource.

contacts - list

List of contacts added for this notification group

[edit] Examples

[edit] Successful retrieval

Request

GET https://api.hostway.com/accounts/test-358536378/dedicatedServers/test-358536378-000001338fd091e/ipAddresses/11.22.33.44/monitoring/notificationGroups/186

Response:

OK (200):

{
   "notificationGroup": {
	"name": "test_group2",
	"id": "186"
   },
   "links": [{
	"href": "{{APIBaseURL}}/accounts/test-358536378/dedicatedServers/test-358536378-000001338fd091e/ipAddresses/11.22.33.44/monitoring/notificationGroups/186",
	"rel": "self"
   }],
   "contacts": [{
	"href": "{{APIBaseURL}}/accounts/test-358536378/dedicatedServers/test-358536378-000001338fd091e/ipAddresses/11.22.33.44/monitoring/notificationGroups/186/contacts",
	"rel": "related"
   }]
}

[edit] Resource not found

Request

GET https://api.hostway.com/accounts/test-358536378/dedicatedServers/test-358536378-000001338fd091e/ipAddresses/11.22.33.44/monitoring/notificationGroups/9999

Response

Item Not Found (404):

 {"error": {"message": "Not Found", "code": 404, "details": "Not Found"}}

[edit] See also

• Monitoring API
• Common Features