Hostway API Documentation - User contributions [en]

Monitoring/Checks History

2015-05-13T13:18:24Z

Mitko.georgiev:

='''GET''' /accounts/'''account_id'''/dedicatedServers/'''dedicated_server_id'''/ipAddresses/'''ip_address/monitoring/events=
'''This API call is deprecated!'''

Get history checks/events/ list

== Result ==
=== JSON ===
<nowiki>
{
"events" : [ {
"status" : "OK",
"description" : "HTTP",
"timestamp" : 1349962341,
"id" : 6499684,
"type" : "TCP",
"port" : 80,
"name" : "HTTP"
}, {
"status" : "ERROR",
"description" : "HTTP",
"timestamp" : 1349962332,
"id" : 6499683,
"type" : "TCP",
"port" : 80,
"name" : "HTTP"
}, {
"status" : "ERROR",
"description" : "PING",
"timestamp" : 1349962325,
"id" : 6499682,
"type" : "PING",
"port" : 0,
"name" : "PING"
}, {
"status" : "OK",
"description" : "PING",
"timestamp" : 1349962317,
"id" : 6499681,
"type" : "PING",
"port" : 0,
"name" : "PING"
}, {
"status" : "OK",
"description" : "HTTP",
"timestamp" : 1349962308,
"id" : 6499680,
"type" : "TCP",
"port" : 80,
"name" : "HTTP"
}, {
"status" : "ERROR",
"description" : "HTTP",
"timestamp" : 1349962297,
"id" : 6499679,
"type" : "TCP",
"port" : 80,
"name" : "HTTP"
} ]
}
</nowiki>

== Response Codes ==
; Success
: ''OK (200)''

; Failure
: ''Unauthorized (401)'' : 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.
: ''No Permission (403)''
: ''Not Found (404)'' : The resource requested is not found. Returned when either of account_id, dedicated_server_id or ip_address parameters do not exist.

== Examples(errors) ==
'''GET''' /accounts/fake_account_id/dedicatedServers/dedicated_server_id_123/ipAddresses/11.22.33.44/monitoring/events

''- Response:''
:''Not Found (404)'':
{"itemNotFound": {"message": "/accounts/fake_account_id/dedicatedServers/dedicated_server_id_123/ipAddresses/11.22.33.44/monitoring/events", "code": 404, "details": ""}}

'''GET''' /accounts/account_id_123/dedicatedServers/fake_dedicated_server_id/ipAddresses/11.22.33.44/monitoring/events

''- Response:''
:''Not Found (404)'':
{"itemNotFound": {"message": "/accounts/account_id_123/dedicatedServers/fake_dedicated_server_id/ipAddresses/11.22.33.44/monitoring/events", "code": 404, "details": ""}}

'''GET''' /accounts/account_id_123/dedicatedServers/dedicated_server_id_123/ipAddresses/99.99.99.99/monitoring/events

''- Response:''
:''Not Found (404)'':
{"itemNotFound": {"message": "/accounts/account_id_123/dedicatedServers/dedicated_server_id_123/ipAddresses/99.99.99.99/monitoring/events", "code": 404, "details": ""}}

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

Monitoring/Process

2015-05-13T13:17:52Z

Mitko.georgiev:

='''POST''' /accounts/'''account_number'''/dedicatedServers/'''dedicated_server_id'''/ipAddresses/'''ip_address'''/monitoring/process=
'''This API call is deprecated!'''

Create a Process check

== Parameters ==
; account_number - ''string''
; dedicated_server_id - ''string''
; ip_address - ''string''

== Request==
=== JSON ===
<nowiki>
{
"monitoring": {
"check": {
"enabled": true,
"enabledAlert": false
},
"options": {
"checkProcessType" : "COUNT",
"maxProcess" : 10
}
}
}
</nowiki>

====monitoring====
=====check=====
; check.enabled - ''boolean''
: Enable the check

; check.enabledAlert - ''boolean''
: Enable alerts

=====options=====
; options.checkProcessType - ''int''
: The type of process monitoring check
; options.maxProcess - ''int''
: The maximum threshold number of processes

== Response==
=== JSON ===
<nowiki>
{
"monitoring": {
"type": "process",
"options": {
"processName": null,
"maxProcess": 10,
"checkProcessType": "COUNT"
},
"check": {
"status": "UNKNOWN",
"lastCheck": 0,
"enabledAlert": false,
"enabled": true,
"id": 19
}
},
"links": [{
"href": "http://{server-name}/accounts/account_number/dedicatedServers/dedicated_server_id/ipAddresses/ip_address/monitoring/process/19",
"rel": "self"
}]
}
</nowiki>

====monitoring====
; type - ''string''
: process

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

=====check=====
; check.id - ''string''
: Unique identifier for this check.

; check.status
: Status of the process check

; check.lastCheck
: Time of last process check

; check.enabled - ''boolean''
: Is the check enabled

; check.enabledAlert - ''boolean''
: Are alerts enabled

=====options=====
; options.processName - ''string''
: The name of the monitored process
; options.maxProcess - ''int''
: The threshold count for this monitoring check
; options.checkProcessType - ''string''
: The type of process check

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

; Failure
: ''HTTP/1.1 400 Bad Request'': There was an error in the request the client sent
: ''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 403 Forbidden'' : You don't have permissions to access the resource
: ''HTTP/1.1 404 Not Found'' : The resource requested is not found.
: ''HTTP/1.1 409 Conflict'' : Only one process check for Dedicated Server per IP is allowed

== Examples ==
'''Successfully create a process check'''
:'''POST''' http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/process

''Request:''
{"monitoring": {"check": {"enabled": true, "enabledAlert": false}, "options": {"checkProcessType" : "COUNT", "maxProcess" : 10 }}}

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

''Response Body:''
<nowiki>
{
"monitoring": {
"type": "process",
"options": {
"processName": null,
"maxProcess": 10,
"checkProcessType": "COUNT"
},
"check": {
"status": "UNKNOWN",
"lastCheck": 0,
"enabledAlert": false,
"enabled": true,
"id": 19
}
},
"links": [{
"href": "http://{server-name}/accounts/account_number/dedicatedServers/dedicated_server_id/ipAddresses/ip_address/monitoring/process/19",
"rel": "self"
}]
}
</nowiki>

'''Bad request - missing options in the request body'''
:'''POST''' http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/process

''Request:''
{"monitoring": {"check": {"enabled": false, "enabledAlert": false}}}

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

''Response Body:''
{"badRequest": {"message": "POST data error", "code": 400, "details": {"monitoring.options": "Required"}}}

'''Request to create process check for a missing dedicated server or IP address'''
:'''POST''' http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{fake_server}/ipAddresses/{ip_address}/monitoring/process
:'''POST''' http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{fake_ip}/monitoring/process
''Request:''
{"monitoring": {"check": {"enabled": true, "enabledAlert": false}, "options": {"checkProcessType" : "COUNT", "maxProcess" : 10}}}

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

'''Add an already existing process check'''
:'''POST''' http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/process

''Request:''
{"monitoring": {"check": {"enabled": true, "enabledAlert": false}, "options": {"checkProcessType" : "COUNT", "maxProcess" : 10}}}

''Response Code:''
<pre>HTTP/1.1 409 Conflict</pre>

='''GET''' /accounts/'''account'''/dedicatedServers/'''dedicated_server'''/ipAddresses/'''ip_address'''/monitoring/process/'''id'''=
'''This API call is deprecated!'''

Get process check details

== Parameters ==
; account - ''string''
; dedicated_server - ''string''
; ip_address - ''string''
; id - ''string''
: Id of the process check.

== Response ==
=== JSON ===
<nowiki>
{
"monitoring": {
"type": "{type}",
"options": {
"processName": null,
"maxProcess": 10,
"checkProcessType": "COUNT"
},
"check": {
"status": {status},
"lastCheck": {last_check},
"enabledAlert": {enabled_alert},
"enabled": {enabled},
"id": {id}
}
},
"links": [
{
"href": "http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server_id}/ipAddresses/{ip_address}/monitoring/process/{id}", "rel": "self"
}
]
}
</nowiki>

====monitoring====
; type - ''string''
: process

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

=====check=====
; check.id - ''string''
: Unique identifier for this check.

; check.status
: Status of the process check

; check.lastCheck
: Time of last process check

; check.enabled - ''boolean''
: Is the check enabled

; check.enabledAlert - ''boolean''
: Are alerts enabled

=====options=====
; options.processName - ''string''
: The name of monitored process
; options.maxProcess - ''int''
: The threshold count for this monitoring check
; options.checkProcessType - ''string''
: The type of process check

== 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 403 Forbidden'' : You don't have permissions to access the resource
: ''HTTP/1.1 404 Not Found'' : The resource requested is not found.

== Examples ==
'''View process check details'''
:'''GET''' http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/process/19

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

''Response Body:''
<nowiki>
{
"monitoring": {
"type": "process",
"options": {
"processName": null,
"maxProcess": 10,
"checkProcessType": "COUNT"
},
"check": {
"status": "UNKNOWN",
"lastCheck": 0,
"enabledAlert": false,
"enabled": true,
"id": 19
}
},
"links": [
{
"href": "http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/process/19", "rel": "self"
}
]
}
</nowiki>

'''Access a non-existing process check'''
:'''GET''' http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/process/9999

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

'''Request a check for missing server or IP addresss'''
:'''GET''' http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{fake_server}/ipAddresses/{ip_address}/monitoring/process/19
:'''GET''' http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{fake_ip}/monitoring/process/19

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

='''PUT''' /accounts/'''account'''/dedicatedServers/'''dedicated_server'''/ipAddresses/'''ip_address'''/monitoring/process/'''id'''=
'''This API call is deprecated!'''

Update process monitoring check

== Parameters ==
; account - ''string''
; dedicated_server - ''string''
; ip_address - ''string''
; id - ''string''
: Id of the process check.

== Request==
=== JSON ===
<nowiki>
{
"monitoring": {
"check": {
"enabled": {enabled},
"enabledAlert": {enabled_alert}
},
"options": {
"checkProcessType" : "COUNT",
"maxProcess" : 5
},
}
}
</nowiki>

====monitoring====
=====check=====
; check.enabled - ''boolean''
: Enable the check

; check.enabledAlert - ''boolean''
: Enable alerts

=====options=====
; options.maxProcess - ''int''
: The threshold count for this monitoring check
; options.checkProcessType - ''string''
: The type of process check

== Response==
=== JSON ===
<nowiki>
{
"monitoring": {
"type": "{type}",
"options": {
"checkProcessType" : "COUNT",
"maxProcess" : 5
},
"check": {
"status": {status},
"lastCheck": {last_check},
"enabledAlert": {enabled_alert},
"enabled": {enabled},
"id": {id}
}
},
"links": [
{
"href": "http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/process/{id}", "rel": "self"
}
]
}
</nowiki>

====monitoring====
; type - ''string''
: process

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

=====check=====
; check.id - ''string''
: Unique identifier for this check.

; check.status
: Status of the process check

; check.lastCheck
: Time of last process check

; check.enabled - ''boolean''
: Is the check enabled

; check.enabledAlert - ''boolean''
: Are alerts enabled

=====options=====
; options.maxProcess - ''int''
: The threshold count for this monitoring check
; options.checkProcessType - ''string''
: The type of process check

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

; 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 403 Forbidden''
: ''HTTP/1.1 404 Not Found'' : The resource requested is not found.

== Examples ==
'''Update existing process check'''
:'''PUT''' http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/process/19

''Request:''
{"monitoring": {"check": {"enabled": true, "enabledAlert": false}, "options": {"checkProcessType" : "COUNT", "maxProcess" : 5}}}

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

''Response Body:''
<nowiki>
{
"monitoring": {
"type": "process",
"options": {
"processName": null,
"maxProcess": 5,
"checkProcessType": "COUNT"
},
"check": {
"status": "UNKNOWN",
"lastCheck": 0,
"enabledAlert": false,
"enabled": true,
"id": 19
}
},
"links": [
{
"href": "http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/process/19", "rel": "self"
}
]
}
</nowiki>

'''Bad request - update a process check with wrong request data'''
:'''PUT''' http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/process/19

''Request:''
{"monitoring": {"options": {"maxProcess": 5, "checkProcessType": "COUNT"}}}

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

''Response Body:''
{"badRequest": {"message": "POST data error", "code": 400, "details": {"monitoring.check": "Required"}}}

'''Try to update a missing process check resource'''
:'''PUT''' http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/process/9999

''Request:''
{"monitoring": {"check": {"enabled": true, "enabledAlert": false}, "options": {"maxProcess": 5, "checkProcessType": "COUNT"}}}

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

='''DELETE''' /accounts/'''account'''/dedicatedServers/'''dedicated_server'''/ipAddresses/'''ip_address'''/monitoring/process/'''id'''=
'''This API call is deprecated!'''

Delete process check

== Parameters ==
; account - ''string''
; dedicated_server - ''string''
; ip_address - ''string''
; id - ''string''
: Id of the process check.

== Response Codes ==
; Success deleting the resource
: ''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 403 Forbidden''
: ''HTTP/1.1 404 Not Found'' : The resource requested is not found.

== Examples ==
'''Successfully delete a process check'''
:'''DELETE''' http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/process/19

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

'''Request to delete a missing process check resource'''
:'''DELETE''' http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/process/9999

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

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

Monitoring/Disk

2015-05-13T13:17:08Z

Mitko.georgiev:

='''POST''' /accounts/'''account_number'''/dedicatedServers/'''dedicated_server'''/ipAddresses/'''ip_address'''/monitoring/disk=
'''This API call is deprecated!'''

Creates Disk check

== Parameters ==
; account_number - ''string''
; dedicated_server - ''string''
; ip_address - ''string''

== Request==
=== JSON ===
<nowiki>
{
"monitoring": {
"check": {
"enabled": true,
"enabledAlert": false
},
"options": {
"freeSpace": 10,
"partition": "/"
}
}
}
</nowiki>

====monitoring====
=====check=====
; check.enabled - ''boolean''
: Enable the check
; check.enabledAlert - ''boolean''
: Enable alerts

=====options=====
; options.freeSpace - ''int''
: The disk space usage limit for check alerts
; options.partition - ''string''
: The partition identifier

== Response==
=== JSON ===
<nowiki>
{
"monitoring": {
"type": "disk",
"options": {
"freeSpace": 10,
"partition": "/"
},
"check": {
"status": {status},
"lastCheck": {last_check},
"enabledAlert": {enabled_alert},
"enabled": {enabled},
"id": {id}
}
},
"links": [
{
"href": "http(s)://{api_server}/accounts/{account_id}/dedicatedServers/{dedicated_server_id}/ipAddresses/{ip_address}/monitoring/disk/{id}",
"rel": "self"
}
]
}
</nowiki>

====monitoring====
; type - ''string''
: disk

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

=====check=====
; check.id - ''string''
: Unique identifier for this check.

; check.status
: Status of the disk check - possible values: null, OK, Warning, Critical, Unknown

; check.lastCheck
: Time of last disk check

; check.enabled - ''boolean''
: Is the check enabled

; check.enabledAlert - ''boolean''
: Are alerts enabled

=====options=====
; options.freeSpace - ''int''
: The disk space usage limit for check alerts
; options.partition - ''string''
: The partition identifier

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

; Failure
: ''HTTP/1.1 400 Bad Request'': There was an error in the request the client sent
: ''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 403 Forbidden'' : You don't have permissions to access the resource
: ''HTTP/1.1 404 Not Found'' : The resource requested is not found.
: ''HTTP/1.1 409 Conflict'' : Only one disk check for Dedicated Server per IP is allowed

== Examples ==
'''Successfully create a disk check'''
:'''POST''' http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/disk

''Request:''
{"monitoring": {"check": {"enabled": true, "enabledAlert": false}, "options": {"freeSpace" : 10, "partition" : "/"}}}

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

''Response Body:''
<nowiki>
{
"monitoring": {
"type": "disk",
"options": {
"freeSpace": 10,
"partition": "/"
},
"check": {
"status": null,
"lastCheck": null,
"enabledAlert": false,
"enabled": true,
"id": 17
}
},
"links": [
{
"href": "http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/disk/17",
"rel": "self"
}
]
}
</nowiki>

'''Bad request - missing options in the request body'''
:'''POST''' http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/disk
''Request:''
{"monitoring": {"check": {"enabled": false, "enabledAlert": false}}}

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

''Response Body:''
{"badRequest": {"message": "POST data error", "code": 400, "details": {"monitoring.options": "Required"}}}

'''Request to create disk check for a missing dedicated server or IP address'''
:'''POST''' http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{fake_server}/ipAddresses/{ip_address}/monitoring/disk
:'''POST''' http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{fake_ip}/monitoring/disk

''Request:''
{"monitoring": {"check": {"enabled": true, "enabledAlert": false}, "options": {"freeSpace" : 10, "partition" : "/"}}}

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

'''Add an existing disk check'''
:'''POST''' http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/disk

''Request:''
{"monitoring": {"check": {"enabled": true, "enabledAlert": false}, "options": {"freeSpace" : 10, "partition" : "/"}}}

''Response Code:''
<pre>HTTP/1.1 409 Conflict</pre>

='''GET''' /accounts/'''account'''/dedicatedServers/'''dedicated_server'''/ipAddresses/'''ip_address'''/monitoring/disk/'''id'''=
'''This API call is deprecated!'''

Get disk check details

== Parameters ==
; account - ''string''
; dedicated_server - ''string''
; ip_address - ''string''
; id - ''string''
: Id of the disk check.

== Response ==
=== JSON ===
<nowiki>
{
"monitoring": {
"type": disk,
"options": {
"freeSpace": 10,
"partition": "/"
},
"check": {
"status": {status},
"lastCheck": {last_check},
"enabledAlert": {enabled_alert},
"enabled": {enabled},
"id": 17
}
},
"links": [
{
"href": "http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/disk/{id}",
"rel": "self"
}
]
}
</nowiki>

====monitoring====
; type - ''string''
: disk

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

=====check=====
; check.id - ''string''
: Unique identifier for this check.

; check.status
: Status of the disk check - possible values: null, OK, Warning, Critical, Unknown

; check.lastCheck
: Time of last disk check

; check.enabled - ''boolean''
: Is the check enabled

; check.enabledAlert - ''boolean''
: Are alerts enabled

=====options=====
; options.freeSpace - ''int''
: The disk space usage limit for check alerts
; options.partition - ''string''
: The partition used for check

== 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 403 Forbidden'' : You don't have permissions to access the resource
: ''HTTP/1.1 404 Not Found'' : The resource requested is not found.

== Examples ==
'''View disk check details'''
:'''GET''' http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/disk/17

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

''Response Body:''
<nowiki>
{
"monitoring": {
"type": "disk",
"options": {
"freeSpace": 10,
"partition": "/"
},
"check": {
"status": null,
"lastCheck": null,
"enabledAlert": false,
"enabled": true,
"id": 17
}
},
"links": [
{
"href": "http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/disk/17",
"rel": "self"
}
]
}
</nowiki>

'''Access a non-existing disk check'''
:'''GET''' http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/disk/0000

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

'''Request a check for missing server or IP addresss'''
:'''GET''' http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{fake_server}/ipAddresses/{ip_address}/monitoring/disk/17
:'''GET''' http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{fake_ip}/monitoring/disk/17

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

='''PUT''' /accounts/'''account'''/dedicatedServers/'''dedicated_server'''/ipAddresses/'''ip_address'''/monitoring/disk/'''id'''=
'''This API call is deprecated!'''

Update disk check

== Parameters ==
; account - ''string''
; dedicated_server - ''string''
; ip_address - ''string''
; id - ''string''
: Id of the disk check.

== Request==
=== JSON ===
<nowiki>
{
"monitoring": {
"check": {
"enabled": {enabled},
"enabledAlert": {enabled_alert}
},
"options": {
"freeSpace" : 15,
"partition" : "/"
},
}
}
</nowiki>

====monitoring====
=====check=====
; check.enabled - ''boolean''
: Enable the check

; check.enabledAlert - ''boolean''
: Enable alerts

=====options=====
; options.freeSpace - ''int''
: The disk space usage limit for check alerts
; options.partition - ''string''
: The disk partition identifier

== Response==
=== JSON ===
<nowiki>
{
"monitoring": {
"type": "{type}",
"options": {
"freeSpace": 15,
"partition": "/"
},
"check": {
"status": {status},
"lastCheck": {last_check},
"enabledAlert": {enabledAlert},
"enabled": {enabled},
"id": {id}
}
},
"links": [
{
"href": "http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/disk/{id}",
"rel": "self"
}
]
}
</nowiki>

====monitoring====
; type - ''string''
: disk

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

=====check=====
; check.id - ''string''
: Unique identifier for this check.

; check.status
: Status of the disk check - possible values: null, OK, Warning, Critical, Unknown

; check.lastCheck
: Time of last disk check

; check.enabled - ''boolean''
: Is the check enabled

; check.enabledAlert - ''boolean''
: Are alerts enabled

=====options=====
; options.freeSpace - ''int''
: The disk space usage limit for check alerts
; options.partition - ''string''
: The disk partition identifier

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

; 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 403 Forbidden''
: ''HTTP/1.1 404 Not Found'' : The resource requested is not found.

== Examples ==
'''Update existing disk check'''
:'''PUT''' http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/disk/17

''Request:''
{"monitoring": {"check": {"enabled": true, "enabledAlert": false}, "options": {"freeSpace": 15, "partition": "/"}}}

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

''Response Body:''
<nowiki>
{
"monitoring": {
"type": "disk",
"options": {
"freeSpace": 15,
"partition": "/"
},
"check": {
"status": null,
"lastCheck": 1334148166,
"enabledAlert": false,
"enabled": true,
"id": 17
}
},
"links": [
{
"href": "http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/disk/17",
"rel": "self"
}
]
}
</nowiki>

'''Bad request - update a disk check with wrong request data'''
:'''PUT''' http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/disk/17

''Request:''
{"monitoring": {"options": {"freeSpace" : 15, "partition" : "/"}}}

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

''Response Body:''
{"badRequest": {"message": "POST data error", "code": 400, "details": {"monitoring.check": "Required"}}}

'''Try to update a missing disk check resource'''
:'''PUT''' http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/disk/000

''Request:''
{"monitoring": {"check": {"enabled": true, "enabledAlert": false}, "options": {"freeSpace" : 15, "partition" : "/"}}}

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

='''DELETE''' /accounts/'''account'''/dedicatedServers/'''dedicated_server'''/ipAddresses/'''ip_address'''/monitoring/disk/'''id'''=
'''This API call is deprecated!'''

Delete disk check

== Parameters ==
; account - ''string''
; dedicated_server - ''string''
; ip_address - ''string''
; id - ''string''
: Id of the disk check.

== Response Codes ==
; Success deleting the resource
: ''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 403 Forbidden''
: ''HTTP/1.1 404 Not Found'' : The resource requested is not found.

== Examples ==
'''Successfully delete a disk check'''
:'''DELETE''' http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/disk/17

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

'''Request to delete a missing disk check resource'''
:'''DELETE''' http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/disk/000

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

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

Monitoring/Memory

2015-05-13T13:16:23Z

Mitko.georgiev:

='''POST''' /accounts/'''account_number'''/dedicatedServers/'''dedicated_server'''/ipAddresses/'''ip_address'''/monitoring/memory=
'''This API call is deprecated!'''

Create Memory check

== Parameters ==
; account - ''string''
; dedicated_server - ''string''
; ip_address - ''string''

== Request==
=== JSON ===
<nowiki>
{
"monitoring": {
"check": {
"enabled": {enabled},
"enabledAlert": {enabled_alert}
},
"options": {
"freeMemory": 1024,
"freeSwap": 2048
}
}
}
</nowiki>

====monitoring====
=====check=====
; check.enabled - ''boolean''
: Enable the check

; check.enabledAlert - ''boolean''
: Enable alerts

=====options=====
; options.freeMemory - ''int''
: The memory usage limit for check alerts
; options.freeSwap - ''int''
: The swap file usage limit for check alerts

== Response==
=== JSON ===
<nowiki>
{
"monitoring": {
"type": "memory",
"options": {
"freeMemory": 1024,
"freeSwap": 2048
},
"check": {
"status": {status},
"lastCheck": {last_check},
"enabledAlert": {enabled_alert},
"enabled": {enabled},
"id": {id}
}
},
"links": [
{
"href": "http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/memory/{id}", "rel": "self"
}
]
}
</nowiki>

====monitoring====
; type - ''string''
: memory

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

=====check=====
; check.id - ''string''
: Unique identifier for this check.

; check.status
: Status of the memory check

; check.lastCheck
: Time of last memory check

; check.enabled - ''boolean''
: Is the check enabled

; check.enabledAlert - ''boolean''
: Are alerts enabled

=====options=====
; options.freeMemory - ''int''
: The memory usage limit for check alerts
; options.freeSwap - ''int''
: The swap file usage limit for check alerts

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

; Failure
: ''HTTP/1.1 400 Bad Request'': There was an error in the request the client sent
: ''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 403 Forbidden'' : You don't have permissions to access the resource
: ''HTTP/1.1 404 Not Found'' : The resource requested is not found.
: ''HTTP/1.1 409 Conflict'' : Only one memory check for Dedicated Server per IP is allowed

== Examples ==
'''Successfully create a memory check'''
:'''POST''' http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/memory

''Request:''
{"monitoring": {"check": {"enabled": false, "enabledAlert": false}, "options": {"freeMemory": 1024, "freeSwap": 1024}}}

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

''Response Body:''
<nowiki>
{
"monitoring": {
"type": "memory",
"options": {
"freeMemory": 1024,
"freeSwap": 1024
},
"check": {
"status": null,
"lastCheck": null,
"enabledAlert": false,
"enabled": true,
"id": 16
}
},
"links": [
{
"href": "http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/memory/16", "rel": "self"
}
]
}
</nowiki>

'''Bad request - missing options in the request body'''
:'''POST''' http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/memory

''Request:''
{"monitoring": {"check": {"enabled": false, "enabledAlert": false}}}

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

''Response Body:''
{"badRequest": {"message": "POST data error", "code": 400, "details": {"monitoring.options": "Required"}}}

'''Request to create memory check for a missing dedicated server or IP address'''
:'''POST''' http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{fake_server}/ipAddresses/{ip_address}/monitoring/memory
:'''POST''' http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{fake_ip}/monitoring/memory

''Request:''
{"monitoring": {"check": {"enabled": true, "enabledAlert": false}, "options": {"freeMemory": 1024, "freeSwap": 1024}}}

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

'''Add an existing memory check'''
:'''POST''' http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/memory

''Request:''
{"monitoring": {"check": {"enabled": true, "enabledAlert": false}, "options": {"freeMemory": 1024, "freeSwap": 1024}}}

''Response Code:''
<pre>HTTP/1.1 409 Conflict</pre>

='''GET''' /accounts/'''account'''/dedicatedServers/'''dedicated_server'''/ipAddresses/'''ip_address'''/monitoring/memory/'''id'''=
'''This API call is deprecated!'''

Get memory check details

== Parameters ==
; account - ''string''
; dedicated_server - ''string''
; ip_address - ''string''
; id - ''string''
: Id of the memory check.

== Response ==
=== JSON ===
<nowiki>
{
"monitoring": {
"type": "{type}",
"options": {
"freeMemory": 1024,
"freeSwap": 2048
},
"check": {
"status": {status},
"lastCheck": {last_check},
"enabledAlert": {enabled_alert},
"enabled": {enabled},
"id": {id}
}
},
"links": [
{
"href": "http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/memory/{id}", "rel": "self"
}
]
}
</nowiki>

====monitoring====
; type - ''string''
: memory

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

=====check=====
; check.id - ''string''
: Unique identifier for this check.

; check.status
: Status of the memory check

; check.lastCheck
: Time of last memory check

; check.enabled - ''boolean''
: Is the check enabled

; check.enabledAlert - ''boolean''
: Are alerts enabled

=====options=====
; options.freeMemory - ''int''
: The memory usage limit for check alerts
; options.freeSwap - ''int''
: The swap file usage limit for check alerts

== 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 403 Forbidden'' : You don't have permissions to access the resource
: ''HTTP/1.1 404 Not Found'' : The resource requested is not found.

== Examples ==
'''View memory check details'''
:'''GET''' http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/memory/16

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

''Response Body:''
<nowiki>
{
"monitoring": {
"type": "memory",
"options": {
"freeMemory": 1024,
"freeSwap": 1024
},
"check": {
"status": null,
"lastCheck": null,
"enabledAlert": false,
"enabled": true,
"id": 16
}
},
"links": [
{
"href": "http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/memory/16", "rel": "self"
}
]
}
</nowiki>

'''Access a non-existing memory check'''
:'''GET''' http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/memory/9999

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

'''Request a check for missing server or IP addresss'''
:'''GET''' http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{fake_server}/ipAddresses/{ip_address}/monitoring/memory/16
:'''GET''' http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{fake_ip}/monitoring/memory/16

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

='''PUT''' /accounts/'''account'''/dedicatedServers/'''dedicated_server'''/ipAddresses/'''ip_address'''/monitoring/memory/'''id'''=
'''This API call is deprecated!'''

Update memory check

== Parameters ==
; account - ''string''
; dedicated_server - ''string''
; ip_address - ''string''
; id - ''string''
: Id of the memory check.

== Request==
=== JSON ===
<nowiki>
{
"monitoring": {
"check": {
"enabled": {enabled},
"enabledAlert": {enabled_alert}
},
"options": {
"freeMemory": 1024,
"freeSwap": 2048
},
}
}
</nowiki>

====monitoring====
=====check=====
; check.enabled - ''boolean''
: Enable the check

; check.enabledAlert - ''boolean''
: Enable alerts

=====options=====
; options.freeMemory - ''int''
: The memory usage limit for check alerts
; options.freeSwap - ''int''
: The swap file usage limit for check alerts

== Response==
=== JSON ===
<nowiki>
{
"monitoring": {
"type": "{type}",
"options": {
"freeMemory": 1024,
"freeSwap": 2048
},
"check": {
"status": {status},
"lastCheck": {last_check},
"enabledAlert": {enabled_alert},
"enabled": {enabled},
"id": {id}
}
},
"links": [
{
"href": "http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/memory/{id}", "rel": "self"
}
]
}
</nowiki>

====monitoring====
; type - ''string''
: memory

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

=====check=====
; check.id - ''string''
: Unique identifier for this check.

; check.status
: Status of the memory check

; check.lastCheck
: Time of last memory check

; check.enabled - ''boolean''
: Is the check enabled

; check.enabledAlert - ''boolean''
: Are alerts enabled

=====options=====
; options.freeMemory - ''int''
: The memory usage limit for check alerts
; options.freeSwap - ''int''
: The swap file usage limit for check alerts

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

; 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 403 Forbidden''
: ''HTTP/1.1 404 Not Found'' : The resource requested is not found.

== Examples ==
'''Update existing memory check''''
:'''PUT''' http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/memory/16

''Request:''
{"monitoring": {"check": {"enabled": true, "enabledAlert": false}, "options": {"freeMemory": 2048, "freeSwap": 2048}}}

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

''Response Body:''
<nowiki>
{
"monitoring": {
"type": "memory",
"options": {
"freeMemory": 2048,
"freeSwap": 2048
},
"check": {
"status": ERROR,
"lastCheck": 1334148166,
"enabledAlert": false,
"enabled": true,
"id": 16
}
},
"links": [
{
"href": "http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/memory/16", "rel": "self"
}
]
}
</nowiki>

'''Bad request - update a memory check with wrong request data'''
:'''PUT''' http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/memory/16

''Request:''
{"monitoring": {"options": {"freeMemory": 1024, "freeSwap": 1024}}}

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

''Response Body:''
{"badRequest": {"message": "POST data error", "code": 400, "details": {"monitoring.check": "Required"}}}

'''Try to update a missing memory check resource'''
:'''PUT''' http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/memory/9999

''Request:''
{"monitoring": {"check": {"enabled": true, "enabledAlert": false}, "options": {"freeMemory": 1024, "freeSwap": 1024}}}

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

='''DELETE''' /accounts/'''account'''/dedicatedServers/'''dedicated_server'''/ipAddresses/'''ip_address'''/monitoring/memory/'''id'''=
'''This API call is deprecated!'''

Delete memory check

== Parameters ==
; account - ''string''
; dedicated_server - ''string''
; ip_address - ''string''
; id - ''string''
: Id of the memory check.

== Response Codes ==
; Success deleting the resource
: ''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 403 Forbidden''
: ''HTTP/1.1 404 Not Found'' : The resource requested is not found.

== Examples ==
'''Successfully delete a memory check'''
:'''DELETE''' http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/memory/16

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

'''Request to delete a missing memory check resource'''
:'''DELETE''' http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/memory/9999

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

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

Monitoring/CPU

2015-05-13T13:15:27Z

Mitko.georgiev:

='''POST''' /accounts/'''account'''/dedicatedServers/'''dedicated_server'''/ipAddresses/'''ip_address'''/monitoring/cpu=
'''This API call is deprecated!'''

Create CPU check

== Parameters ==
; account - ''string''
; dedicated_server - ''string''
; ip_address - ''string''

== Request==
=== JSON ===
<nowiki>
{
"monitoring": {
"check": {
"enabled": {enabled},
"enabledAlert": {enabled_alert}
},
"options": {
"maxLoad": {max_load}
}
}
}
</nowiki>

====monitoring====
=====check=====
; check.enabled - ''boolean''
: Enable the check

; check.enabledAlert - ''boolean''
: Enable alerts

=====options=====
; options.maxLoad - ''number''

== Result==
=== JSON ===
<nowiki>
{
"monitoring": {
"type": "{type}",
"options": {
"maxLoad": {max_load}
},
"check": {
"status": {status},
"lastCheck": {last_check},
"enabledAlert": {enabled_alert},
"enabled": {enabled},
"id": {id}
}
},
"links": [
{
"href": "{server_name}/accounts/{account}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/cpu/{id}", "rel": "self"
}
]
}
</nowiki>

====monitoring====
; type - ''string''
: cpu

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

=====check=====
; check.id - ''string''
: Unique identifier for this check.

; check.status
: Status of the cpu check

; check.lastCheck
: Time of last cpu check

; check.enabled - ''boolean''
: Is the check enabled

; check.enabledAlert - ''boolean''
: Are alerts enabled

=====options=====
; options.maxLoad - ''int''

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

; Failure
: ''HTTP/1.1 400 Bad Request'': There was an error in the request the client sent
: ''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 403 Forbidden'' : You don't have permissions to access the resource
: ''HTTP/1.1 404 Not Found'' : The resource requested is not found.
: ''HTTP/1.1 409 Conflict'' : Only one memory check for Dedicated Server per IP is allowed

== Examples ==
'''POST''' http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/cpu

''Request:''
{"monitoring" : {"check": {"enabled": true, "enabledAlert": false}, "options": {"maxLoad": 1.0}}}

''Response:''
:''HTTP/1.1 201 Created'':
{"monitoring": {"type": "cpu", "options": {"maxLoad": 1.0}, "check": {"status": null, "lastCheck": null, "enabledAlert": false, "enabled": true, "id": 18}}, "links": [{"href": "{server_name}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/cpu/18", "rel": "self"}]}

'''POST''' http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/cpu

''Request:''
{"monitoring" : {"check": {"enabledAlert": false}, "options": {"maxLoad": 1.0}}}
''Response:''
: ''HTTP/1.1 400 Bad Request'':
{"badRequest": {"message": "POST data error", "code": 400, "details": {"monitoring.check.enabled": "Required"}}}

'''POST''' http(s)://{api_server}/accounts/{account_number}/dedicatedServers/abc/ipAddresses/{ip_address}/monitoring/cpu

''Request:''
{"monitoring" : {"check": {"enabledAlert": false}, "options": {"maxLoad": 1.0}}}
''Response:''
:''HTTP/1.1 404 Not Found''

'''POST''' http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/cpu

''Request:''
{"monitoring" : {"check": {"enabled": true, "enabledAlert": false }, "options": {"maxLoad": 1.0}}}
''Response:''
:''HTTP/1.1 409 Conflict''

='''GET''' /accounts/'''account'''/dedicatedServers/'''dedicated_server'''/ipAddresses/'''ip_address'''/monitoring/cpu/'''id'''=
'''This API call is deprecated!'''

Get CPU check details

== Parameters ==
; account - ''string''
; dedicated_server - ''string''
; ip_address - ''string''
; id - ''string''
: Id of the cpu check.

== Result ==
=== JSON ===
<nowiki>
{
"monitoring": {
"type": "{type}",
"options": {
"maxLoad": {max_load}
},
"check": {
"status": {status},
"lastCheck": {last_check},
"enabledAlert": {enabled_alert},
"enabled": {enabled},
"id": {id}
}
},
"links": [
{
"href": "{server_name}/accounts/{account}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/cpu/{id}", "rel": "self"
}
]
}
</nowiki>

====monitoring====
; type - ''string''
: cpu

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

=====check=====
; check.id - ''string''
: Unique identifier for this check.

; check.status
: Status of the cpu check

; check.lastCheck
: Time of last cpu check

; check.enabled - ''boolean''
: Is the check enabled

; check.enabledAlert - ''boolean''
: Are alerts enabled

=====options=====
; options.maxLoad - ''number''

== 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 403 Forbidden'' : You don't have permissions to access the resource
: ''HTTP/1.1 404 Not Found'' : The resource requested is not found.

== Examples ==
'''GET''' http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/cpu/18

''Response:''
:''HTTP/1.1 200 Ok'':
{"monitoring": {"type": "cpu", "options": {"maxLoad": 1.0}, "check": {"status": null, "lastCheck": null, "enabledAlert": false, "enabled": true, "id": 18}}, "links": [{"href": "{server_name}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/cpu/18/", "rel": "self"}]}

'''GET''' http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/cpu/9999

''Response:''
:''HTTP/1.1 404 Not Found''

'''GET''' http(s)://{api_server}/accounts/{account_number}/dedicatedServers/abc/ipAddresses/{ip_address}/monitoring/cpu/18

''Response:''
:''HTTP/1.1 404 Not Found''

='''PUT''' /accounts/'''account'''/dedicatedServers/'''dedicated_server'''/ipAddresses/'''ip_address'''/monitoring/cpu/'''id'''=
'''This API call is deprecated!'''

Update CPU check

== Parameters ==
; account - ''string''
; dedicated_server - ''string''
; ip_address - ''string''
; id - ''string''
: Id of the cpu check.

== Request==
=== JSON ===
<nowiki>
{
"monitoring": {
"check": {
"enabled": {enabled},
"enabledAlert": {enabled_alert}
},
"options": {
"maxLoad": {max_load}
}
}
}
</nowiki>

====monitoring====
=====check=====
; check.enabled - ''boolean''
: Enable the check

; check.enabledAlert - ''boolean''
: Enable alerts

=====options=====
; options.maxLoad - ''int''

== Result==
=== JSON ===
<nowiki>
{
"monitoring": {
"type": "{type}",
"options": {
"maxLoad": {max_load}
},
"check": {
"status": {status},
"lastCheck": {last_check},
"enabledAlert": {enabled_alert},
"enabled": {enabled},
"id": {id}
}
},
"links": [
{
"href": "{server_name}/accounts/{account}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/cpu/{id}", "rel": "self"
}
]
}
</nowiki>

====monitoring====
; type - ''string''
: cpu

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

=====check=====
; check.id - ''string''
: Unique identifier for this check.

; check.status
: Status of the cpu check

; check.lastCheck
: Time of last cpu check

; check.enabled - ''boolean''
: Is the check enabled

; check.enabledAlert - ''boolean''
: Are alerts enabled

=====options=====
; options.maxLoad - ''int''

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

; 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 403 Forbidden''
: ''HTTP/1.1 404 Not Found'' : The resource requested is not found.

== Examples ==
'''PUT''' http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/cpu/18

''Request:''
{"monitoring" : {"check": {"enabled": true, "enabledAlert": false}, "options": {"maxLoad": 0.5}}}

''Response:''
:''HTTP/1.1 200 Ok'':
{"monitoring": {"type": "cpu", "options": {"maxLoad": 0.5}, "check": {"status": null, "lastCheck": null, "enabledAlert": false, "enabled": true, "id": 18}}, "links": [{"href": "{server_name}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/cpu/18/", "rel": "self"}]}

'''PUT''' http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/cpu/18

''Request:''
{"monitoring": {"options": {"maxLoad": 0.5}}}

''Response:''
: ''HTTP/1.1 400 Bad Request'':
{"badRequest": {"message": "POST data error", "code": 400, "details": {"monitoring.check": "Required"}}}

'''PUT''' http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/cpu/9999

''Request:''
{"monitoring": {"check": {"enabled": false, "enabledAlert": false}, "options": {"maxLoad": 0.5}}}

''Response:''
:''HTTP/1.1 404 Not Found''

='''DELETE''' /accounts/'''account'''/dedicatedServers/'''dedicated_server'''/ipAddresses/'''ip_address'''/monitoring/cpu/'''id'''=
'''This API call is deprecated!'''

Delete CPU check

== Parameters ==
; account - ''string''
; dedicated_server - ''string''
; ip_address - ''string''
; id - ''string''
: Id of the cpu check.

== Response Codes ==
; Success deleting the resource
: ''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 403 Forbidden''
: ''HTTP/1.1 404 Not Found'' : The resource requested is not found.

== Examples ==
'''DELETE''' http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/cpu/18

''Response:''
:''HTTP/1.1 204 No Content''

'''DELETE''' http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/cpu/9999

''Response:''
:''HTTP/1.1 404 Not Found''

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

Monitoring/Port

2015-05-13T13:14:33Z

Mitko.georgiev:

='''POST''' /accounts/'''account'''/dedicatedServers/'''dedicated_server'''/ipAddresses/'''ip_address'''/monitoring/port=
'''This API call is deprecated!'''

Create PORT check

== Parameters ==
; account - ''string''
; dedicated_server - ''string''
; ip_address - ''string''

== Request==
=== JSON ===
<nowiki>
{
"monitoring": {
"check": {
"enabled": {enabled},
"enabledAlert": {enabled_alert}
},
"options": {
"port": {port}
}
}
}
</nowiki>

====monitoring====
=====check=====
; check.enabled - ''boolean''
: Enable the check

; check.enabledAlert - ''boolean''
: Enable alerts

=====options=====
; options.port- ''int''

== Result==
=== JSON ===
<nowiki>
{
"monitoring": {
"type": "{type}",
"options": {
"port": {port}
},
"check": {
"status": {status},
"lastCheck": {last_check},
"enabledAlert": {enabled_alert},
"enabled": {enabled},
"id": {id}
}
},
"links": [
{
"href": "{server_name}/accounts/{account}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/port/{id}", "rel": "self"
}
]
}
</nowiki>

====monitoring====
; type - ''string''
: port

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

=====check=====
; check.id - ''string''
: Unique identifier for this check.

; check.status
: Status of the port check

; check.lastCheck
: Time of last port check

; check.enabled - ''boolean''
: Is the check enabled

; check.enabledAlert - ''boolean''
: Are alerts enabled

=====options=====
; options.port - ''int''

== Response Codes ==
; Success
: ''Created (201)''

; Failure
: ''Bad Request (400)''
: ''Unauthorized (401)'' : 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.
: ''No Permission (403)''
: ''Not Found (404)'' : The resource requested is not found.
: ''Conflict (409)''

== Examples ==
'''POST {server_name}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/port'''

''Request:''
{"monitoring" : {"check": {"enabled": true, "enabledAlert": false }, "options": {"port": 8981}}}

''Response:''
:''Created (201)'':
{"monitoring": {"type": "port", "options": {"port": 8981}, "check": {"status": null, "lastCheck": null, "enabledAlert": false, "enabled": true, "id": 42}}, "links": [{"href": "{server_name}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/port/42", "rel": "self"}]}

'''POST {server_name}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/port'''

''Request:''
{"monitoring" : {"check": {"enabledAlert": false}, "options": {"port": 8981}}}
''Response:''
: ''Bad Request (400)'':
{"badRequest": {"message": "POST data error", "code": 400, "details": {"monitoring.check.enabled": "Required"}}}

'''POST {server_name}/accounts/{account_number}/dedicatedServers/abc/ipAddresses/{ip_address}/monitoring/port'''

''Request:''
{"monitoring" : {"check": {"enabledAlert": false}, "options": {"port": 8080}}}
''Response:''
:''Not Found (404)''

'''POST {server_name}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/port'''

''Request:''
{"monitoring" : {"check": {"enabled": true, "enabledAlert": false }, "options": {"port": 8981}}}
''Response:''
:''Conflict (409)''

='''GET''' /accounts/'''account'''/dedicatedServers/'''dedicated_server'''/ipAddresses/'''ip_address'''/monitoring/port/'''id'''=
'''This API call is deprecated!'''

Get PORT check details

== Parameters ==
; account - ''string''
; dedicated_server - ''string''
; ip_address - ''string''
; id - ''string''
: Id of the port check.

== Result ==
=== JSON ===
<nowiki>
{
"monitoring": {
"type": "{type}",
"options": {
"port": {port}
},
"check": {
"status": {status},
"lastCheck": {last_check},
"enabledAlert": {enabled_alert},
"enabled": {enabled},
"id": {id}
}
},
"links": [
{
"href": "{server_name}/accounts/{account}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/port/{id}", "rel": "self"
}
]
}
</nowiki>

====monitoring====
; type - ''string''
: port

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

=====check=====
; check.id - ''string''
: Unique identifier for this check.

; check.status
: Status of the port check

; check.lastCheck
: Time of last port check

; check.enabled - ''boolean''
: Is the check enabled

; check.enabledAlert - ''boolean''
: Are alerts enabled

=====options=====
; options.port - ''int''

== Response Codes ==
; Success
: ''OK (200)''

; Failure
: ''Unauthorized (401)'' : 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.
: ''No Permission (403)''
: ''Not Found (404)'' : The resource requested is not found.

== Examples ==
'''GET {server_name}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/port/42'''

''Response:''
:''OK (200)'':
{"monitoring": {"type": "port", "options": {"port": 8981}, "check": {"status": null, "lastCheck": null, "enabledAlert": false, "enabled": false, "id": 42}}, "links": [{"href": "{server_name}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/port/42/", "rel": "self"}]}

'''GET {server_name}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/port/9999'''

''Response:''
:''Not Found (404)''

'''GET {server_name}/accounts/{account_number}/dedicatedServers/abc/ipAddresses/{ip_address}/monitoring/port/42'''

''Response:''
:''Not Found (404)''

='''PUT''' /accounts/'''account'''/dedicatedServers/'''dedicated_server'''/ipAddresses/'''ip_address'''/monitoring/port/'''id'''=
'''This API call is deprecated!'''

Update PORT check

== Parameters ==
; account - ''string''
; dedicated_server - ''string''
; ip_address - ''string''
; id - ''string''
: Id of the port check.

== Request==
=== JSON ===
<nowiki>
{
"monitoring": {
"check": {
"enabled": {enabled},
"enabledAlert": {enabled_alert}
},
"options": {
"port": {port}
}
}
}
</nowiki>

====monitoring====
=====check=====
; check.enabled - ''boolean''
: Enable the check

; check.enabledAlert - ''boolean''
: Enable alerts

=====options=====
; options.port - ''int''

== Result==
=== JSON ===
<nowiki>
{
"monitoring": {
"type": "{type}",
"options": {
"port": {port}
},
"check": {
"status": {status},
"lastCheck": {last_check},
"enabledAlert": {enabled_alert},
"enabled": {enabled},
"id": {id}
}
},
"links": [
{
"href": "{server_name}/accounts/{account}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/port/{id}", "rel": "self"
}
]
}
</nowiki>

====monitoring====
; type - ''string''
: port

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

=====check=====
; check.id - ''string''
: Unique identifier for this check.

; check.status
: Status of the port check

; check.lastCheck
: Time of last port check

; check.enabled - ''boolean''
: Is the check enabled

; check.enabledAlert - ''boolean''
: Are alerts enabled

=====options=====
; options.port - ''int''

== Response Codes ==
; Success
: ''OK (200)''

; Failure
: ''Bad Request (400)''
: ''Unauthorized (401)'' : 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.
: ''No Permission (403)''
: ''Not Found (404)'' : The resource requested is not found.
: ''Bad Gateway (502)''

== Examples ==
'''PUT {server_name}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/port/42'''

''Request:''
{"monitoring": {"check": {"enabled": false, "enabledAlert": false}, "options": {"port": 8981}}}

''Response:''
:''OK (200)'':
{"monitoring": {"type": "port", "options": {"port": 8981}, "check": {"status": null, "lastCheck": null, "enabledAlert": false, "enabled": false, "id": 42}}, "links": [{"href": "{server_name}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/port/42/", "rel": "self"}]}

'''PUT {server_name}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/port/42'''

''Request:''
{"monitoring": {"options": {"port": 8981}}}

''Response:''
: ''Bad Request (400)'':
{"badRequest": {"message": "POST data error", "code": 400, "details": {"monitoring.check": "Required"}}}

'''PUT {server_name}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/port/9999'''

''Request:''
{"monitoring": {"check": {"enabled": false, "enabledAlert": false}, "options": {"port": 8981}}}

''Response:''
:''Not Found (404)''

'''PUT {server_name}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/port/42'''

''Request:''
{"monitoring": {"check": {"enabled": false, "enabledAlert": false}, "options": {"port": 8080}}}

''Response:''
:''Bad Gateway (502)''

='''DELETE''' /accounts/'''account'''/dedicatedServers/'''dedicated_server'''/ipAddresses/'''ip_address'''/monitoring/port/'''id'''=
'''This API call is deprecated!'''

Delete PORT check

== Parameters ==
; account - ''string''
; dedicated_server - ''string''
; ip_address - ''string''
; id - ''string''
: Id of the port check.

== Response Codes ==
; Success
: ''No Content (204)''

; Failure
: ''Unauthorized (401)'' : 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.
: ''No Permission (403)''
: ''Not Found (404)'' : The resource requested is not found.

== Examples ==
'''DELETE {server_name}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/port/42'''

''Response:''
:''No Content (204)''

'''DELETE {server_name}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/port/9999'''

''Response:''
:''Not Found (404)''

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

Monitoring/Ping

2015-05-13T13:12:27Z

Mitko.georgiev:

='''POST''' /accounts/'''account'''/dedicatedServers/'''dedicated_server'''/ipAddresses/'''ip_address'''/monitoring/ping=
'''This API call is deprecated!'''

Create PING check

== Parameters ==
; account - ''string''
; dedicated_server - ''string''
; ip_address - ''string''

== Request==
=== JSON ===
<nowiki>
{
"monitoring": {
"check": {
"enabled": {enabled},
"enabledAlert": {enabled_alert}
},
"options": {
"count": {count}
}
}
}
</nowiki>

====monitoring====
=====check=====
; check.enabled - ''boolean''
: Enable the check

; check.enabledAlert - ''boolean''
: Enable alerts

=====options=====
; options.count - ''int''

== Result==
=== JSON ===
<nowiki>
{
"monitoring": {
"type": "{type}",
"options": {
"count": {count}
},
"check": {
"status": {status},
"lastCheck": {last_check},
"enabledAlert": {enabled_alert},
"enabled": {enabled},
"id": {id}
}
},
"links": [
{
"href": "{server_name}/accounts/{account}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/ping/{id}", "rel": "self"
}
]
}
</nowiki>

====monitoring====
; type - ''string''
: ping

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

=====check=====
; check.id - ''string''
: Unique identifier for this check.

; check.status
: Status of the ping check

; check.lastCheck
: Time of last ping check

; check.enabled - ''boolean''
: Is the check enabled

; check.enabledAlert - ''boolean''
: Are alerts enabled

=====options=====
; options.count - ''int''

== Response Codes ==
; Success
: ''Created (201)''

; Failure
: ''Bad Request (400)''
: ''Unauthorized (401)'' : 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.
: ''No Permission (403)''
: ''Not Found (404)'' : The resource requested is not found.
: ''Conflict (409)'' : Only one ping for Dedicated Server is allowed

== Examples ==
'''POST {server_name}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/ping'''

''Request:''
{"monitoring": {"check": {"enabled": false, "enabledAlert": false}, "options": {"count": 10}}}

''Response:''
:''Created (201)'':
{"monitoring": {"type": "ping", "options": {"count": 10}, "check": {"status": null, "lastCheck": null, "enabledAlert": false, "enabled": false, "id": 16}}, "links": [{"href": "{server_name}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/ping/16", "rel": "self"}]}

'''POST {server_name}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/ping'''

''Request:''
{"monitoring": {"check": {"enabled": false, "enabledAlert": false}}}
''Response:''
: ''Bad Request (400)'':
{"badRequest": {"message": "POST data error", "code": 400, "details": {"monitoring.options": "Required"}}}

'''POST {server_name}/accounts/{account_number}/dedicatedServers/abc/ipAddresses/{ip_address}/monitoring/ping'''

''Request:''
{"monitoring": {"check": {"enabled": true, "enabledAlert": false}, "options": {"count": 10}}}
''Response:''
:''Not Found (404)''

'''POST {server_name}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/ping'''

''Request:''
{"monitoring": {"check": {"enabled": true, "enabledAlert": false}, "options": {"count": 10}}}
''Response:''
:''Conflict (409)''

='''GET''' /accounts/'''account'''/dedicatedServers/'''dedicated_server'''/ipAddresses/'''ip_address'''/monitoring/ping/'''id'''=
'''This API call is deprecated!'''

Get PING check details

== Parameters ==
; account - ''string''
; dedicated_server - ''string''
; ip_address - ''string''
; id - ''string''
: Id of the ping check.

== Result ==
=== JSON ===
<nowiki>
{
"monitoring": {
"type": "{type}",
"options": {
"count": {count}
},
"check": {
"status": {status},
"lastCheck": {last_check},
"enabledAlert": {enabled_alert},
"enabled": {enabled},
"id": {id}
}
},
"links": [
{
"href": "{server_name}/accounts/{account}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/ping/{id}", "rel": "self"
}
]
}
</nowiki>

====monitoring====
; type - ''string''
: ping

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

=====check=====
; check.id - ''string''
: Unique identifier for this check.

; check.status
: Status of the ping check

; check.lastCheck
: Time of last ping check

; check.enabled - ''boolean''
: Is the check enabled

; check.enabledAlert - ''boolean''
: Are alerts enabled

=====options=====
; options.count - ''int''

== Response Codes ==
; Success
: ''OK (200)''

; Failure
: ''Unauthorized (401)'' : 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.
: ''No Permission (403)''
: ''Not Found (404)'' : The resource requested is not found.

== Examples ==
'''GET {server_name}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/ping/16'''

''Response:''
:''OK (200)'':
{"monitoring": {"type": "ping", "options": {"count": 10}, "check": {"status": "ERROR", "lastCheck": 1334148166, "enabledAlert": false, "enabled": false, "id": 16}}, "links": [{"href": "{server_name}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/ping/16/", "rel": "self"}]}

'''GET {server_name}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/ping/9999'''

''Response:''
:''Not Found (404)''

'''GET {server_name}/accounts/{account_number}/dedicatedServers/abc/ipAddresses/{ip_address}/monitoring/ping/16'''

''Response:''
:''Not Found (404)''

='''PUT''' /accounts/'''account'''/dedicatedServers/'''dedicated_server'''/ipAddresses/'''ip_address'''/monitoring/ping/'''id'''=
'''This API call is deprecated!'''

Update PING check

== Parameters ==
; account - ''string''
; dedicated_server - ''string''
; ip_address - ''string''
; id - ''string''
: Id of the ping check.

== Request==
=== JSON ===
<nowiki>
{
"monitoring": {
"check": {
"enabled": {enabled},
"enabledAlert": {enabled_alert}
},
"options": {
"count": {count}
}
}
}
</nowiki>

====monitoring====
=====check=====
; check.enabled - ''boolean''
: Enable the check

; check.enabledAlert - ''boolean''
: Enable alerts

=====options=====
; options.count - ''int''

== Result==
=== JSON ===
<nowiki>
{
"monitoring": {
"type": "{type}",
"options": {
"count": {count}
},
"check": {
"status": {status},
"lastCheck": {last_check},
"enabledAlert": {enabled_alert},
"enabled": {enabled},
"id": {id}
}
},
"links": [
{
"href": "{server_name}/accounts/{account}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/ping/{id}", "rel": "self"
}
]
}
</nowiki>

====monitoring====
; type - ''string''
: ping

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

=====check=====
; check.id - ''string''
: Unique identifier for this check.

; check.status
: Status of the ping check

; check.lastCheck
: Time of last ping check

; check.enabled - ''boolean''
: Is the check enabled

; check.enabledAlert - ''boolean''
: Are alerts enabled

=====options=====
; options.count - ''int''

== Response Codes ==
; Success
: ''OK (200)''

; Failure
: ''Bad Request (400)''
: ''Unauthorized (401)'' : 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.
: ''No Permission (403)''
: ''Not Found (404)'' : The resource requested is not found.

== Examples ==
'''PUT {server_name}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/ping/16'''

''Request:''
{"monitoring": {"check": {"enabled": true, "enabledAlert": false}, "options": {"count": 3}}}

''Response:''
:''OK (200)'':
{"monitoring": {"type": "ping", "options": {"count": 3}, "check": {"status": "ERROR", "lastCheck": 1334148166, "enabledAlert": false, "enabled": true, "id": 16}}, "links": [{"href": "{server_name}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/ping/16/", "rel": "self"}]}

'''PUT {server_name}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/ping/16'''

''Request:''
{"monitoring": {"options": {"count": 3}}}

''Response:''
: ''Bad Request (400)'':
{"badRequest": {"message": "POST data error", "code": 400, "details": {"monitoring.check": "Required"}}}

'''PUT {server_name}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/ping/9999'''

''Request:''
{"monitoring": {"check": {"enabled": true, "enabledAlert": false}, "options": {"count": 3}}}

''Response:''
:''Not Found (404)''

='''DELETE''' /accounts/'''account'''/dedicatedServers/'''dedicated_server'''/ipAddresses/'''ip_address'''/monitoring/ping/'''id'''=
'''This API call is deprecated!'''

Delete PING check

== Parameters ==
; account - ''string''
; dedicated_server - ''string''
; ip_address - ''string''
; id - ''string''
: Id of the ping check.

== Response Codes ==
; Success
: ''No Content (204)''

; Failure
: ''Unauthorized (401)'' : 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.
: ''No Permission (403)''
: ''Not Found (404)'' : The resource requested is not found.

== Examples ==
'''DELETE {server_name}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/ping/16'''

''Response:''
:''No Content (204)''

'''DELETE {server_name}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/ping/9999'''

''Response:''
:''Not Found (404)''

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

Monitoring/Checks

2015-05-13T13:10:19Z

Mitko.georgiev:

='''GET''' /accounts/'''account_id'''/dedicatedServers/'''dedicated_server_id'''/ipAddresses/'''ip_address/monitoring/checks=
'''This API call is deprecated!'''

Get list of active Monitoring checks

== Result ==
=== JSON ===
<nowiki>
{
"list": [
{
"status": "ok",
"lastCheck": 0,
"enabled": true,
"details": "http://{server-name}/accounts/{accountId}/dedicatedServers/{dedicatedServerId}/ipAddresses/{ipAddress}/monitoring/port/{checkId}"
},
{
"status": "error",
"lastCheck": 0,
"enabled": true,
"details": "http://{server-name}/accounts/{accountId}/dedicatedServers/{dedicatedServerId}/ipAddresses/{ipAddress}/monitoring/ping/{checkId}"
},
{
"status": "unknown",
"lastCheck": 0,
"enabled": true,
"details": "http://{server-name}/accounts/{accountId}/dedicatedServers/{dedicatedServerId}/ipAddresses/{ipAddress}/monitoring/cpu/{checkId}"
}
],
"links": [
{
"href": "http://{server-name}/accounts/{accountId}/dedicatedServers/{dedicatedServerId}/ipAddresses/{ipAddress}/monitoring/checks/",
"rel": "self"
}
]
}
</nowiki>

== Response Codes ==
; Success
: ''OK (200)''

; Failure
: ''Unauthorized (401)'' : 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.
: ''No Permission (403)''
: ''Not Found (404)'' : The resource requested is not found. Returned when either of account_id, dedicated_server_id or ip_address parameters do not exist.

== Examples(errors) ==
'''GET''' /accounts/fake_account_id/dedicatedServers/dedicated_server_id_123/ipAddresses/11.22.33.44/monitoring/checks

''- Response:''
:''Not Found (404)'':
{"itemNotFound": {"message": "/accounts/fake_account_id/dedicatedServers/dedicated_server_id_123/ipAddresses/11.22.33.44/monitoring/checks", "code": 404, "details": ""}}

'''GET''' /accounts/account_id_123/dedicatedServers/fake_dedicated_server_id/ipAddresses/11.22.33.44/monitoring/checks

''- Response:''
:''Not Found (404)'':
{"itemNotFound": {"message": "/accounts/account_id_123/dedicatedServers/fake_dedicated_server_id/ipAddresses/11.22.33.44/monitoring/checks", "code": 404, "details": ""}}

'''GET''' /accounts/account_id_123/dedicatedServers/dedicated_server_id_123/ipAddresses/99.99.99.99/monitoring/checks

''- Response:''
:''Not Found (404)'':
{"itemNotFound": {"message": "/accounts/account_id_123/dedicatedServers/dedicated_server_id_123/ipAddresses/99.99.99.99/monitoring/checks", "code": 404, "details": ""}}

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

Accounts-accountNumber-dedicatedServers-serverId-ipAddresses-ipAddr-monitoring-notificationGroups-groupId-contacts-contactId:DELETE

2015-05-13T13:09:56Z

Mitko.georgiev:

=DELETE /accounts/''{accountNumber}''/dedicatedServers/''{serverId}''/ipAddresses/''{ipAddr}''/monitoring/notificationGroups/''{groupId}''=
'''This API call is deprecated!'''

Delete a contact

__TOC__

== Request ==
<code>DELETE /accounts/''{accountNumber}''/dedicatedServers/''{serverId}''/ipAddresses/''{ipAddr}''/monitoring/notificationGroups/''{groupId}''/contacts/''{contactId}''</code>

==== Request Parameters ====
; accountNumber - ''string''
; serverId - ''string''
; ipAddr - ''string''
; groupId - ''string''
: Id of the notification group
; contactId - ''string''
: Id of the contact in this notification group

=== URI Parameters ===
None

=== Request Headers ===
; Authorization
: Specify the '''Authorization''' header when requesting details for an order that was already submitted. Follow the instructions for API [[Authentication]].

== Response ==

=== Status Code ===
;204 No Content
: 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.

== Examples ==
=== Successful deletion ===
'''Request'''

<code>DELETE {{APIBaseURL}}/accounts/test-358536378/dedicatedServers/test-358536378-000001338fd091e/ipAddresses/11.22.33.44/monitoring/notificationGroups/186/contacts/1556</code>

'''Response:'''
:''OK (204)'':

=== Resource not found ===
'''Request'''

<code>DELETE {{APIBaseURL}}/accounts/test-358536378/dedicatedServers/test-358536378-000001338fd091e/ipAddresses/11.22.33.44/monitoring/notificationGroups/186/contacts/9999</code>

'''Response'''
:''Item Not Found (404)'':

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

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

Accounts-accountNumber-dedicatedServers-serverId-ipAddresses-ipAddr-monitoring-notificationGroups-groupId-contacts-contactId:PUT

2015-05-13T13:09:41Z

Mitko.georgiev:

=PUT /accounts/''{accountNumber}''/dedicatedServers/''{serverId}''/ipAddresses/''{ipAddr}''/monitoring/notificationGroups/''{groupId}''=
'''This API call is deprecated!'''

Update a contact

__TOC__

== Request ==
<code>PUT /accounts/''{accountNumber}''/dedicatedServers/''{serverId}''/ipAddresses/''{ipAddr}''/monitoring/notificationGroups/''{groupId}''/contacts/''{contactId}''</code>

==== Request Parameters ====
; accountNumber - ''string''
; serverId - ''string''
; ipAddr - ''string''
; groupId - ''string''
: Id of the notification group
; contactId - ''string''
: Id of the contact in this notification group

=== URI Parameters ===
None

=== Request Headers ===
; Authorization
: Specify the '''Authorization''' header when requesting details for an order that was already submitted. Follow the instructions for API [[Authentication]].

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

=== Request Body ===
<nowiki>
{
"contact": {
"name": "{contact_name}",
"type": "{contact_type}",
"address": "{contact_address}",
"onTime": {contact_ontime},
"offTime": {contact_offtime}
}
}
</nowiki>

==== Parameters ====
; name - ''string''
: Descriptive name for this contact.

; type - ''EMAIL/PAGER''

; address - ''string''
: Email or pager number

; onTime - ''int''

; offTime - ''int''

== Response ==

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

;400 Bad Request
: Invalid user input

;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

=== Response Body ===
<nowiki>
{
"contact": {
"name": "{contact_name}",
"onTime": {contact_ontime},
"links": [
{
"href": "{{APIBaseURL}}/contactgroups/{contactgroup_id}/contacts/{contact_id}/", "rel": "self"
}
],
"address": "{contact_address}",
"offTime": {contact_offtime},
"type": "{contact_type}",
"id": {contact_id}
}
}
</nowiki>

==== Parameters ====
; id - ''string''
: Unique identifier for this contact.

; name - ''string''
: Descriptive name for this contact.

; type - ''EMAIL/PAGER''

; address - ''string''
: Email or pager number

; onTime - ''int''

; offTime - ''int''

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

== Examples ==
=== Successful deletion ===
'''Request'''

<code>PUT {{APIBaseURL}}/accounts/test-358536378/dedicatedServers/test-358536378-000001338fd091e/ipAddresses/11.22.33.44/monitoring/notificationGroups/186/contacts/1556</code>
<nowiki>
{
"contact": {
"name": "test_contact_updated",
"type": "EMAIL",
"address": "updated_abc@abc.com",
"onTime": 50400,
"offTime": 11600
}
}
</nowiki>

'''Response'''
:''OK (200)'':
<nowiki>
{
"contact": {
"onTime": 50400,
"name": "test_contact_updated",
"address": "updated_abc@abc.com",
"offTime": 11600,
"type": "EMAIL",
"id": 1556
},
"links": [{
"href": "{{APIBaseURL}}/accounts/test-358536378/dedicatedServers/test-358536378-000001338fd091e/ipAddresses/11.22.33.44/monitoring/notificationGroups/186/contacts/1556",
"rel": "self"
}]
}
</nowiki>

=== Wrong input ===
'''Request'''

<code>PUT {{APIBaseURL}}/accounts/test-358536378/dedicatedServers/test-358536378-000001338fd091e/ipAddresses/11.22.33.44/monitoring/notificationGroups/186/contacts/1556</code
<nowiki>
{
"contact": {
"name": "test_contact_updated",
"type": "FAX",
"address": "updated_abc.com",
"onTime": 50400,
"offTime": 21600
}
}
</nowiki>

'''Response'''
:''Bad Request (400)'':
<nowiki>
{
"badRequest": {
"message": "POST data error",
"code": 400,
"details": {
"contact.address": "Invalid email address",
"contact.type": "\"FAX\" is not one of EMAIL"
}
}
}
</nowiki>

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

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

Accounts-accountNumber-dedicatedServers-serverId-ipAddresses-ipAddr-monitoring-notificationGroups-groupId-contacts-contactId:GET

2015-05-13T13:09:24Z

Mitko.georgiev:

=GET /accounts/''{accountNumber}''/dedicatedServers/''{serverId}''/ipAddresses/''{ipAddr}''/monitoring/notificationGroups/''{groupId}''/contacts/''{contactId}''=
'''This API call is deprecated!'''

List contact details

__TOC__

== Request ==
<code>GET /accounts/''{accountNumber}''/dedicatedServers/''{serverId}''/ipAddresses/''{ipAddr}''/monitoring/notificationGroups/''{groupId}''/contacts/''{contactId}''</code>

==== Request Parameters ====
; accountNumber - ''string''
; serverId - ''string''
; ipAddr - ''string''
; groupId - ''string''
: Id of the notification group
; contactId - ''string''
: Id of the contact in this notification group

=== URI Parameters ===
None

=== Request Headers ===
; Authorization
: Specify the '''Authorization''' header when requesting details for an order that was already submitted. Follow the instructions for API [[Authentication]].

== Response ==

=== 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

=== Response Body ===
<nowiki>
{
"contacts": [
{
"name": "{contact_name}",
"onTime": {contact_ontime},
"links": [
{
"href": "{{APIBaseURL}}/accounts/{accountNumber}/dedicatedServers/{serverId}/ipAddresses/{ipAddr}/monitoring/notificationGroups/{groupId}/contacts/{contactId}/",
"rel": "self"
}
],
"address": "{contact_address}",
"offTime": {contact_offtime},
"type": "{contact_type}",
"id": {contact_id}
}
]
}
</nowiki>

==== Parameters ====
; id - ''string''
: Unique identifier for this contact.
; name - ''string''
: Descriptive name for this contact.
; type - ''EMAIL/PAGER''
; address - ''string''
: Email or pager number
; onTime - ''int''
; offTime - ''int''
; links - ''list''
: [[Hypermedia]] for this resource.

== Examples ==
=== Successful retrieval ===
'''Request'''

<code>GET {{APIBaseURL}}/accounts/test-358536378/dedicatedServers/test-358536378-000001338fd091e/ipAddresses/11.22.33.44/monitoring/notificationGroups/186/contacts/1556</code>

'''Response'''
:''OK (200)'':
<nowiki>
{
"contact": {
"onTime": 10400,
"name": "test_contact_updated",
"address": "updated_abc@abc.com",
"offTime": 11600,
"type": "EMAIL",
"id": 1556
},
"links": [{
"href": "{{APIBaseURL}}/accounts/test-358536378/dedicatedServers/test-358536378-000001338fd091e/ipAddresses/11.22.33.44/monitoring/notificationGroups/186/contacts/1556",
"rel": "self"
}]
}
</nowiki>

=== Resource not found ===
'''Request'''

<code>GET {{APIBaseURL}}/accounts/test-358536378/dedicatedServers/test-358536378-000001338fd091e/ipAddresses/11.22.33.44/monitoring/notificationGroups/186/contacts/9999</code>

'''Response'''
:''Item Not Found (404)'':

<nowiki>
{
"itemNotFound": {
"message": "Resource not found",
"code": 404,
"details": ""
}
</nowiki>

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

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

Accounts-accountNumber-dedicatedServers-serverId-ipAddresses-ipAddr-monitoring-notificationGroups-groupId-contacts:POST

2015-05-13T13:09:09Z

Mitko.georgiev:

=POST /accounts/''{accountNumber}''/dedicatedServers/''{serverId}''/ipAddresses/''{ipAddr}''/monitoring/notificationGroups/''{groupId}''/contacts=
'''This API call is deprecated!'''

Create a contact

__TOC__

== Request ==
<code>POST /accounts/''{accountNumber}''/dedicatedServers/''{serverId}''/ipAddresses/''{ipAddr}''/monitoring/notificationGroups/''{groupId}''/contacts</code>

==== Request Parameters ====
; accountNumber - ''string''
; serverId - ''string''
; ipAddr - ''string''
; groupId - ''string''
: Id of the notification group

=== URI Parameters ===
None

=== Request Headers ===
; Authorization
: Specify the '''Authorization''' header when requesting details for an order that was already submitted. Follow the instructions for API [[Authentication]].

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

=== Request Body ===
<nowiki>
{
"contact": {
"name": "{contact_name}",
"type": "{contact_type}",
"address": "{contact_address}",
"onTime": {contact_ontime},
"offTime": {contact_offtime}
}
}
</nowiki>

==== Parameters ====
; name - ''string''
: Descriptive name for this contact.

; type - ''EMAIL/PAGER''

; address - ''string''
: Email or pager number

; onTime - ''int''

; offTime - ''int''

== Response ==

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

;400 Bad Request
: Invalid user input

;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

=== Response Body ===
<nowiki>
{
"contact": {
"name": "{contact_name}",
"onTime": {contact_ontime},
"links": [
{
"href": "{{APIBaseURL}}/accounts/{accountNumber}/dedicatedServers/{serverId}/ipAddresses/{ipAddr}/monitoring/notificationGroups/{groupId}/contacts/{contact_id}/",
"rel": "self"
}
],
"address": "{contact_address}",
"offTime": {contact_offtime},
"type": "{contact_type}",
"id": {contact_id}
}
}
</nowiki>

==== Parameters ====
; id - ''string''
: Unique identifier for this contact.

; name - ''string''
: Descriptive name for this contact.

; type - ''EMAIL/PAGER''

; address - ''string''
: Email or pager number

; onTime - ''int''

; offTime - ''int''

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

== Examples ==
=== Successfully create a notification contact ===
'''Request'''

<code>POST {{APIBaseURL}}/accounts/test-358536378/dedicatedServers/test-358536378-000001338fd091e/ipAddresses/11.22.33.44/monitoring/notificationGroups/186/contacts</code>
<nowiki>
{
"contact": {
"name": "test_contact",
"type": "EMAIL",
"address": "abc@abc.com",
"onTime": 50400,
"offTime": 21600
}
}
</nowiki>

'''Response'''
:''Created (201)'':
<nowiki>
{
"contact": {
"onTime": 50400,
"name": "test_contact",
"address": "abc@abc.com",
"offTime": 21600,
"type": "EMAIL",
"id": 1556
},
"links": [{
"href": "{{APIBaseURL}}/accounts/test-358536378/dedicatedServers/test-358536378-000001338fd091e/ipAddresses/11.22.33.44/monitoring/notificationGroups/186/contacts/1556",
"rel": "self"
}]
}
</nowiki>

=== Failure creating a notification contact with wrong request data ===
'''Request'''

<code>POST {{APIBaseURL}}/accounts/test-358536378/dedicatedServers/test-358536378-000001338fd091e/ipAddresses/11.22.33.44/monitoring/notificationGroups/186/contacts</code>
<nowiki>
{
"contact": {
"name": "test_contact",
"type": "EMAIL",
"address": "abc.com",
"onTime": 50400,
"offTime": 21600
}
}
</nowiki>

'''Response'''
:''Bad Request (400)'':
<nowiki>
{
"badRequest": {
"message": "POST data error",
"code": 400,
"details": {
"contact.address": "Invalid email address"
}
}
}
</nowiki>

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

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

Accounts-accountNumber-dedicatedServers-serverId-ipAddresses-ipAddr-monitoring-notificationGroups-groupId-contacts:GET

2015-05-13T13:08:52Z

Mitko.georgiev:

=GET /accounts/''{accountNumber}''/dedicatedServers/''{serverId}''/ipAddresses/''{ipAddr}''/monitoring/notificationGroups/''{groupId}''/contacts=
'''This API call is deprecated!'''

List contacts

__TOC__

== Request ==
<code>GET /accounts/''{accountNumber}''/dedicatedServers/''{serverId}''/ipAddresses/''{ipAddr}''/monitoring/notificationGroups/''{groupId}''/contacts</code>

==== Request Parameters ====
; accountNumber - ''string''
; serverId - ''string''
; ipAddr - ''string''
; groupId - ''string''
: Id of the notification group

=== URI Parameters ===
None

=== Request Headers ===
; Authorization
: Specify the '''Authorization''' header when requesting details for an order that was already submitted. Follow the instructions for API [[Authentication]].

== Response ==

=== 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

=== Response Body ===
<nowiki>
{
"links": [
{
"href": "{{APIBaseURL}}/accounts/{accountNumber}/dedicatedServers/{serverId}/ipAddresses/{ipAddr}/monitoring/notificationGroups/{groupId}/contacts",
"rel": "self"
}
],
"contacts": [
{
"href": "{contactLocation}",
"rel": "related"
}
]
}
</nowiki>

==== Parameters ====
; contacts - ''list''
: A list of all the contacts defined for the given notification group

;: contactLocation - ''string''
:: URL of the specific contact's details

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

== Examples ==
=== Success scenario ===
'''Request'''

<code>GET {{APIBaseURL}}/accounts/test-ng-358536378/dedicatedServers/test-ng-358536378-000001338fd091e0419d18a5000a3122/ipAddresses/11.11.10.3/monitoring/notificationGroups/186/contacts/</code>

'''Response'''
<nowiki>
{
"links": [
{
"href": "{{APIBaseURL}}/accounts/test-ng-358536378/dedicatedServers/test-ng-358536378-000001338fd091e0419d18a5000a3122/ipAddresses/11.11.10.3/monitoring/notificationGroups/186/contacts/", "rel": "self"
}
],
"contacts": [
{
"href": "{{APIBaseURL}}/accounts/test-ng-358536378/dedicatedServers/test-ng-358536378-000001338fd091e0419d18a5000a3122/ipAddresses/11.11.10.3/monitoring/notificationGroups/186/contacts/337",
"rel": "related"
},
{
"href": "{{APIBaseURL}}/accounts/test-ng-358536378/dedicatedServers/test-ng-358536378-000001338fd091e0419d18a5000a3122/ipAddresses/11.11.10.3/monitoring/notificationGroups/186/contacts/338",
"rel": "related"
}
]
}
</nowiki>

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

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

Monitoring

2015-05-13T13:08:22Z

Mitko.georgiev:

'''This section is deprecated!'''

== Host ==
* [[Host]]
== Notifications ==
* [[Accounts-accountNumber-dedicatedServers-serverId-ipAddresses-ipAddr-monitoring-notificationGroups-groupId:GET|GET /accounts/{accountNumber}/dedicatedServers/{serverId}/ipAddresses/{ipAddr}/monitoring/notificationGroups/{groupId}]] - Gets single notification group details info
* [[Accounts-accountNumber-dedicatedServers-serverId-ipAddresses-ipAddr-monitoring-notificationGroups-groupId-contacts:GET|GET /accounts/{accountNumber}/dedicatedServers/{serverId}/ipAddresses/{ipAddr}/monitoring/notificationGroups/{groupId}/contacts]] - List contacts
* [[Accounts-accountNumber-dedicatedServers-serverId-ipAddresses-ipAddr-monitoring-notificationGroups-groupId-contacts:POST|POST /accounts/{accountNumber}/dedicatedServers/{serverId}/ipAddresses/{ipAddr}/monitoring/notificationGroups/{groupId}/contacts]] - Create contact
* [[Accounts-accountNumber-dedicatedServers-serverId-ipAddresses-ipAddr-monitoring-notificationGroups-groupId-contacts-contactId:GET|GET /accounts/{accountNumber}/dedicatedServers/{serverId}/ipAddresses/{ipAddr}/monitoring/notificationGroups/{groupId}/contacts/{contactId}]] - List contact details
* [[Accounts-accountNumber-dedicatedServers-serverId-ipAddresses-ipAddr-monitoring-notificationGroups-groupId-contacts-contactId:PUT|PUT /accounts/{accountNumber}/dedicatedServers/{serverId}/ipAddresses/{ipAddr}/monitoring/notificationGroups/{groupId}/contacts/{contactId}]] - Update a contact
* [[Accounts-accountNumber-dedicatedServers-serverId-ipAddresses-ipAddr-monitoring-notificationGroups-groupId-contacts-contactId:DELETE|DELETE /accounts/{accountNumber}/dedicatedServers/{serverId}/ipAddresses/{ipAddr}/monitoring/notificationGroups/{groupId}/contacts/{contactId}]] - Delete a contact
== Checks ==
* [[Monitoring/Checks|Checks]]
* [[Monitoring/Ping|Ping]]
* [[Monitoring/Port|Port]]
* [[Monitoring/CPU|CPU]]
* [[Monitoring/Memory|Memory]]
* [[Monitoring/Disk|Disk]]
* [[Monitoring/Process|Process]]
* [[Monitoring/Checks History|Checks History]]

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

Accounts-accountNumber-dedicatedServers-serverId-ipAddresses-ipAddr-monitoring-notificationGroups-groupId:GET

2015-05-13T13:03:00Z

Mitko.georgiev:

=GET /accounts/''{accountNumber}''/dedicatedServers/''{serverId}''/ipAddresses/''{ipAddr}''/monitoring/notificationGroups/''{groupId}''=
'''This API call is deprecated!'''

Gets single notification group details info.

__TOC__

== Request ==
<code>GET /accounts/''{accountNumber}''/dedicatedServers/''{serverId}''/ipAddresses/''{ipAddr}''/monitoring/notificationGroups/''{groupId}''</code>

==== Request Parameters ====
; accountNumber - ''string''
; serverId - ''string''
; ipAddr - ''string''
; groupId - ''string''
: Id of the notification group

=== URI Parameters ===
None

=== Request Headers ===
; Authorization
: Specify the '''Authorization''' header when requesting details for an order that was already submitted. Follow the instructions for API [[Authentication]].

== Response ==

=== 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.

=== Response Body ===
<nowiki>
{
"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"
}
</nowiki>

==== 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

== Examples ==
=== Successful retrieval ===
'''Request'''

<code>GET {{APIBaseURL}}/accounts/test-358536378/dedicatedServers/test-358536378-000001338fd091e/ipAddresses/11.22.33.44/monitoring/notificationGroups/186</code>

'''Response:'''
:''OK (200)'':
<nowiki>
{
"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"
}]
}
</nowiki>

=== Resource not found ===
'''Request'''

<code>GET {{APIBaseURL}}/accounts/test-358536378/dedicatedServers/test-358536378-000001338fd091e/ipAddresses/11.22.33.44/monitoring/notificationGroups/9999</code>

'''Response'''
:''Item Not Found (404)'':
<nowiki>
{"error": {"message": "Not Found", "code": 404, "details": "Not Found"}}
</nowiki>

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

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

Host

2015-05-13T13:02:15Z

Mitko.georgiev:

'''This API call is deprecated!'''

='''PUT''' /accounts/'''account_id'''/dedicatedServers/'''dedicated_server_id'''/ipAddresses/'''ip_address/monitoring=
Creates a Monitoring host

== Parameters ==
; account_id - ''string''
: Id of the [[Orders#Account|Account]]

; dedicated_server_id - ''string''
: Id of the monitored dedicated server

; ip_address - ''string''
: Dedicated server's IP address specified

== Request==
=== JSON ===
<nowiki>
{
}
</nowiki>

== Result==
=== JSON ===
<nowiki>
{
"orders": [{
"href": "http://{server-name}/orders/{order-id}/action",
"rel": "related"
}],
"links": [{
"href": "http://{server-name}/accounts/{account-number}/dedicatedServers/{dedicated-server-id}/ipAddresses/{ip-address}/monitoring/",
"rel": "self"
}]
}
</nowiki>

== Response Codes ==
; Success
: ''Accepted (202)''

; Failure
: ''Bad Request (400)''
: ''Unauthorized (401)'' : 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.
: ''No Permission (403)''

== Examples ==
'''PUT''' /accounts/test-358536378/dedicatedServers/test-358536378-000001338fd091e/ipAddresses/11.22.33.44/monitoring

''- Response:''
:''Accepted (202)'':
<nowiki>
{
"orders": [{
"href": "http://{server-name}/orders/00000139e48dfcc7639c2ab9000a33dc8c8ae4f8/action",
"rel": "related"
}],
"links": [{
"href": "http://{server-name}/accounts/test-358536378/dedicatedServers/test-358536378-000001338fd091e/ipAddresses/11.22.33.44/monitoring/",
"rel": "self"
}]
}
</nowiki>

='''GET''' /accounts/'''account_id'''/dedicatedServers/'''dedicated_server_id'''/ipAddresses/'''ip_address/monitoring=
Get Monitoring host information

== Result ==
=== JSON ===
<nowiki>
{
"links": [{
"href": "http://{server-name}/accounts/account_id_123/dedicatedServers/dedicated_server_id_123/ipAddresses/11.22.33.44/monitoring/",
"rel": "self"
}],
"notificationGroups": [{
"href": "http://{server-name}/accounts/account_id_123/dedicatedServers/dedicated_server_id_123/ipAddresses/11.22.33.44/monitoring/notificationGroups/186",
"rel": "related"
}],
"process": [{
"href": "http://{server-name}/accounts/account_id_123/dedicatedServers/dedicated_server_id_123/ipAddresses/11.22.33.44/monitoring/process",
"rel": "related"
}],
"ping": [{
"href": "http://{server-name}/accounts/account_id_123/dedicatedServers/dedicated_server_id_123/ipAddresses/11.22.33.44/monitoring/ping",
"rel": "related"
}],
"checks": [{
"href": "http://{server-name}/accounts/account_id_123/dedicatedServers/dedicated_server_id_123/ipAddresses/11.22.33.44/monitoring/checks",
"rel": "self"
}],
"port": [{
"href": "http://{server-name}/accounts/account_id_123/dedicatedServers/dedicated_server_id_123/ipAddresses/11.22.33.44/monitoring/port",
"rel": "related"
}],
"memory": [{
"href": "http://{server-name}/accounts/account_id_123/dedicatedServers/dedicated_server_id_123/ipAddresses/11.22.33.44/monitoring/memory",
"rel": "related"
}],
"disk": [{
"href": "http://{server-name}/accounts/account_id_123/dedicatedServers/dedicated_server_id_123/ipAddresses/11.22.33.44/monitoring/disk",
"rel": "related"
}],
"cpu": [{
"href": "http://{server-name}/accounts/account_id_123/dedicatedServers/dedicated_server_id_123/ipAddresses/11.22.33.44/monitoring/cpu",
"rel": "related"
}]
}
</nowiki>

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

; notificationGroups - ''list''
: Link to [[Contactgroup|Notification Groups]] defined for this monitoring

; process - ''list''
: Link to [[Monitoring/Process|Process]] check for this monitoring

; ping - ''list''
: Link to [[Monitoring/Ping|Ping]] check for this monitoring

; checks - ''list''
: Link to [[Monitoring/Checks|Checks]] list for this monitoring

; port - ''list''
: Link to [[Monitoring/Port|Port]] check for this monitoring

; memory - ''list''
: Link to [[Monitoring/Memory|Memory]] check for this monitoring

; disk - ''list''
: Link to [[Monitoring/Disk|Disk]] check for this monitoring

; cpu - ''list''
: Link to [[Monitoring/CPU|CPU]] check for this monitoring

== Response Codes ==
; Success
: ''OK (200)''

; Failure
: ''Unauthorized (401)'' : 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.
: ''No Permission (403)''
: ''Not Found (404)'' : The resource requested is not found. Returned when either of account_id, dedicated_server_id or ip_address parameters do not exist.

== Examples(errors) ==
'''GET''' /accounts/fake_account_id/dedicatedServers/dedicated_server_id_123/ipAddresses/11.22.33.44/monitoring

''- Response:''
:''Not Found (404)'':
{"itemNotFound": {"message": "/accounts/fake_account_id/dedicatedServers/dedicated_server_id_123/ipAddresses/11.22.33.44/monitoring", "code": 404, "details": ""}}

'''GET''' /accounts/account_id_123/dedicatedServers/fake_dedicated_server_id/ipAddresses/11.22.33.44/monitoring

''- Response:''
:''Not Found (404)'':
{"itemNotFound": {"message": "/accounts/account_id_123/dedicatedServers/fake_dedicated_server_id/ipAddresses/11.22.33.44/monitoring", "code": 404, "details": ""}}

'''GET''' /accounts/account_id_123/dedicatedServers/dedicated_server_id_123/ipAddresses/99.99.99.99/monitoring

''- Response:''
:''Not Found (404)'':
{"itemNotFound": {"message": "/accounts/account_id_123/dedicatedServers/dedicated_server_id_123/ipAddresses/99.99.99.99/monitoring", "code": 404, "details": ""}}

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

Accounts-accountId-products-productId-services-serviceId-action:GET

2015-05-08T12:00:12Z

Mitko.georgiev:

= POST /accounts/''{accountId}''/products/''{productId}''/services/''{serviceId}''/action =
Upgrades/downgrades existing service.
__TOC__
== Request ==
<code>POST /accounts/''{accountId}''/products/''{productId}''/services/''{serviceId}''/action</code>

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

; productId - ''string''
: The Id of the product.

; serviceId - ''string''
: The Id of the service.

=== URI Parameters ===
None.

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

=== Request Body ===
<nowiki>
{
"action": "change",
"actionData": {
"targetServiceSpecification": "</nowiki>{{APIBaseURL}}<nowiki>/serviceSpecifications/{serviceSpecificationId}"
}
}
</nowiki>

==== Parameters ====
; action - ''string''
: The type of the requested action. Currently supported actions:
:: '''cost''' - show the available fees for PTC change
:: '''validate''' - validate if the service specification change is allowed
:: '''change''' - change the service specification (upgrade/downgrade).

; actionData - ''dictionary''
: Contains action-specific data.
:: '''validate''' action:
::: targetServiceSpecification - the URI of the new service specification.
:: '''change''' action:
::: targetServiceSpecification - the URI of the new service specification.

== Response ==

; Response for getting the fees

<nowiki>
{
"links": [{
"href": "http://api.hostway.com/accounts/{accountId}/products/{productId}/services/{serviceId}/action/",
"rel": "self"
}],
"oneTimeFee": {
"currency": "USD",
"amount": "9.95"
},
"taxes": {
"amount": "0"
},
"total": {
"currency": "USD",
"amount": "19.90"
},
"subTotal": {
"currency": "USD",
"amount": "19.90"
}
}
</nowiki>

; Response for the validation

<nowiki>
{
"links": [{
"href": "http://api.hostway.com/accounts/{accountId}/products/{productId}/services/{serviceId}/action/",
"rel": "self"
}],
"allowed": 1
}
</nowiki>

=== Status Code ===
; 200 No Content
: The service update was successfully validated.

; 204 No Content
: The service update was successfully submitted.

; 400 Bad Request
: Request body is invalid.

; 401 Unauthorized
: The authorization credentials were not supplied or are invalid.

; 404 Not Found
: The account, product Id or service Id not found.

=== Response Body ===
None.

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

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