Revision as of 07:17, 13 May 2015 (view source) Mitko.georgiev (Talk)

Latest revision as of 13:36, 30 May 2016 (view source) Corinne.chui (Talk | contribs) m (1 revision)

---

Latest revision as of 13:36, 30 May 2016

Contents 1 POST /accounts/account_number/dedicatedServers/dedicated_server_id/ipAddresses/ip_address/monitoring/process 1.1 Parameters 1.2 Request 1.2.1 JSON 1.2.1.1 monitoring 1.2.1.1.1 check 1.2.1.1.2 options 1.3 Response 1.3.1 JSON 1.3.1.1 monitoring 1.3.1.1.1 check 1.3.1.1.2 options 1.4 Response Codes 1.5 Examples 2 GET /accounts/account/dedicatedServers/dedicated_server/ipAddresses/ip_address/monitoring/process/id 2.1 Parameters 2.2 Response 2.2.1 JSON 2.2.1.1 monitoring 2.2.1.1.1 check 2.2.1.1.2 options 2.3 Response Codes 2.4 Examples 3 PUT /accounts/account/dedicatedServers/dedicated_server/ipAddresses/ip_address/monitoring/process/id 3.1 Parameters 3.2 Request 3.2.1 JSON 3.2.1.1 monitoring 3.2.1.1.1 check 3.2.1.1.2 options 3.3 Response 3.3.1 JSON 3.3.1.1 monitoring 3.3.1.1.1 check 3.3.1.1.2 options 3.4 Response Codes 3.5 Examples 4 DELETE /accounts/account/dedicatedServers/dedicated_server/ipAddresses/ip_address/monitoring/process/id 4.1 Parameters 4.2 Response Codes 4.3 Examples

[edit] POST /accounts/account_number/dedicatedServers/dedicated_server_id/ipAddresses/ip_address/monitoring/process

This API call is deprecated!

Create a Process check

[edit] Parameters

account_number - string

dedicated_server_id - string

ip_address - string

[edit] Request

[edit] JSON

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

[edit] monitoring

[edit] check

check.enabled - boolean

Enable the check

check.enabledAlert - boolean

Enable alerts

[edit] options

options.checkProcessType - int

The type of process monitoring check

options.maxProcess - int

The maximum threshold number of processes

[edit] Response

[edit] JSON

{
   "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"
   }]
}

[edit] monitoring

type - string

process

links - list

Hypermedia for this resource.

[edit] 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

[edit] 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

[edit] 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

[edit] 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:

HTTP/1.1 201 Created

Response Body:

{
   "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"
   }]
}

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:

HTTP/1.1 400 Bad Request

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:

HTTP/1.1 404 Not Found

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:

HTTP/1.1 409 Conflict

[edit] GET /accounts/account/dedicatedServers/dedicated_server/ipAddresses/ip_address/monitoring/process/id

This API call is deprecated!

Get process check details

[edit] Parameters

account - string

dedicated_server - string

ip_address - string

id - string

Id of the process check.

[edit] Response

[edit] JSON

{
   "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"
      }
   ]
}

[edit] monitoring

type - string

process

links - list

Hypermedia for this resource.

[edit] 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

[edit] 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

[edit] 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.

[edit] Examples

View process check details

GET http(s)://{api_server}/accounts/{account_number}/dedicatedServers/{dedicated_server}/ipAddresses/{ip_address}/monitoring/process/19

Response Code:

HTTP/1.1 200 Ok

Response Body:

{
   "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"
      }
   ]
}

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:

HTTP/1.1 404 Not Found

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:

HTTP/1.1 404 Not Found

[edit] PUT /accounts/account/dedicatedServers/dedicated_server/ipAddresses/ip_address/monitoring/process/id

This API call is deprecated!

Update process monitoring check

[edit] Parameters

account - string

dedicated_server - string

ip_address - string

id - string

Id of the process check.

[edit] Request

[edit] JSON

{
   "monitoring": {
      "check": {
            "enabled": {enabled}, 
            "enabledAlert": {enabled_alert}
         }, 
      "options": {
         "checkProcessType" : "COUNT",
         "maxProcess" : 5 
      },
   }
}

[edit] monitoring

[edit] check

check.enabled - boolean

Enable the check

check.enabledAlert - boolean

Enable alerts

[edit] options

options.maxProcess - int

The threshold count for this monitoring check

options.checkProcessType - string

The type of process check

[edit] Response

[edit] JSON

{
   "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"
      }
   ]
}

[edit] monitoring

type - string

process

links - list

Hypermedia for this resource.

[edit] 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

[edit] options

options.maxProcess - int

The threshold count for this monitoring check

options.checkProcessType - string

The type of process check

[edit] 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.

[edit] 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:

HTTP/1.1 200 Ok

Response Body:

{
   "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"
      }
   ]
}

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:

HTTP/1.1 400 Bad Request

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:

HTTP/1.1 404 Not Found

[edit] DELETE /accounts/account/dedicatedServers/dedicated_server/ipAddresses/ip_address/monitoring/process/id

This API call is deprecated!

Delete process check

[edit] Parameters

account - string

dedicated_server - string

ip_address - string

id - string

Id of the process check.

[edit] 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.

[edit] 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:

HTTP/1.1 204 No Content

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:

HTTP/1.1 404 Not Found