Hostway API Documentation - User contributions [en]

List Firewall Groups

2013-06-27T01:04:17Z

Administrator: /* GET /os-security-groups */

This operation will list existing firewall groups.

='''GET''' /os-security-groups=
This operation will list existing firewall groups.

== Response ==
=== JSON ===
<nowiki>
{
"security_groups" : [
{
"display_name" : "{firewall_group_display_name}",
"description" : "{firewall_group_description}",
"links" : [
{
"href" : "http://{api-server}/os-security-groups/{firewall_group_name}/",
"rel" : "self"
}
],
"rules" : [
{
"fromport" : {start_port},
"toport" : {end_port},
"protocol" : "{ip_protocol}",
"cidrIp": "0.0.0.0/0",
"id" : "145"
}
]
"fault" : {
"message" : "",
"code" : "",
"details" : ""
},
"servers" : ["{server_id}"],
"account_number" : "{user_account_number}",
"name" : "{firewall_group_name}"
}
]
}
</nowiki>

====security_groups====
; display name - ''string''
: The display name of the firewall group.

; description - ''string''
: Text describing the firewall group.

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

; rules - ''list''
: List describing all defined security rules for the group.

; fault - ''dictionary''
: Might hold a fault information for the firewall group.

; servers - ''list''
: List of server ids this firewall group is assigned to.

; account_number - ''string''
: Identifies an account that owns the firewall group.

; name - ''string''
: The name of this firewall group.*(Unique identifier for this firewall group.)

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

== Examples ==
'''Successfully list firewall groups'''
:'''GET''' http(s)://{api_server}/os-security-groups

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

''Response Body:''
<nowiki>
{
"security_group" : [
{
"display_name": "Test Firewall Group 1",
"description": "Test firewall group 1 description.",
"links": [
{
"href": "http://{api_server}/os-security-groups/group2012May11_OK30Zs7Ju/",
"rel": "self"
}
],
"rules": [
{
'toport': 1111,
'fromport': 1111,
'protocol': 'TCP',
'id': 145,
'cidrIp': '0.0.0.0/0'
},
{
'toport': 80,
'fromport': 80,
'protocol': 'tcp',
'id': 196,
'cidrIp': '127.0.0.1/24'
}
],
"name": "group2012May11_OK30Zs7Ju",
"account_number": "test_account_120761",
"servers": ["test-server-0003"]
},
{
"display_name": "Test Firewall Group",
"description": "Test firewall group description.",
"links": [
{
"href": "http://{api_server}/os-security-groups/group2012Apr30_9J5qDwOIo/",
"rel": "self"
}
],
"rules": [
{
'toport': 3389,
'fromport': 3389,
'protocol': 'tcp',
'id': 116,
'cidrIp': '0.0.0.0/0'
},
{
'toport': 8443,
'fromport': 8443,
'protocol': 'tcp',
'id': 117,
'cidrIp': '0.0.0.0/0'
},
{
'toport': 22,
'fromport': 22,
'protocol': 'tcp',
'id': 118,
'cidrIp': '0.0.0.0/0'
}
],
"name": "group2012Apr30_9J5qDwOIo",
"account_number": "test_account_901265",
"servers": ["test-server-0011", "test-server-0024"]
}
}
}</nowiki>

'''Failure while trying to make unauthorized access'''
:'''POST''' http(s)://{api_server}/os-security-groups

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded fake_authentication_string

''Response Code:''
<pre>HTTP/1.1 401 Unauthorized</pre>

''Response Body:''
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.

[[Category:Hostway API]]
[[Category:FlexCloud Server API]]

List Firewall Groups

2013-06-27T01:04:02Z

Administrator:

This operation will list existing firewall groups.

='''GET''' /os-security-groups=
This operation lists existing firewall groups.

== Response ==
=== JSON ===
<nowiki>
{
"security_groups" : [
{
"display_name" : "{firewall_group_display_name}",
"description" : "{firewall_group_description}",
"links" : [
{
"href" : "http://{api-server}/os-security-groups/{firewall_group_name}/",
"rel" : "self"
}
],
"rules" : [
{
"fromport" : {start_port},
"toport" : {end_port},
"protocol" : "{ip_protocol}",
"cidrIp": "0.0.0.0/0",
"id" : "145"
}
]
"fault" : {
"message" : "",
"code" : "",
"details" : ""
},
"servers" : ["{server_id}"],
"account_number" : "{user_account_number}",
"name" : "{firewall_group_name}"
}
]
}
</nowiki>

====security_groups====
; display name - ''string''
: The display name of the firewall group.

; description - ''string''
: Text describing the firewall group.

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

; rules - ''list''
: List describing all defined security rules for the group.

; fault - ''dictionary''
: Might hold a fault information for the firewall group.

; servers - ''list''
: List of server ids this firewall group is assigned to.

; account_number - ''string''
: Identifies an account that owns the firewall group.

; name - ''string''
: The name of this firewall group.*(Unique identifier for this firewall group.)

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

== Examples ==
'''Successfully list firewall groups'''
:'''GET''' http(s)://{api_server}/os-security-groups

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

''Response Body:''
<nowiki>
{
"security_group" : [
{
"display_name": "Test Firewall Group 1",
"description": "Test firewall group 1 description.",
"links": [
{
"href": "http://{api_server}/os-security-groups/group2012May11_OK30Zs7Ju/",
"rel": "self"
}
],
"rules": [
{
'toport': 1111,
'fromport': 1111,
'protocol': 'TCP',
'id': 145,
'cidrIp': '0.0.0.0/0'
},
{
'toport': 80,
'fromport': 80,
'protocol': 'tcp',
'id': 196,
'cidrIp': '127.0.0.1/24'
}
],
"name": "group2012May11_OK30Zs7Ju",
"account_number": "test_account_120761",
"servers": ["test-server-0003"]
},
{
"display_name": "Test Firewall Group",
"description": "Test firewall group description.",
"links": [
{
"href": "http://{api_server}/os-security-groups/group2012Apr30_9J5qDwOIo/",
"rel": "self"
}
],
"rules": [
{
'toport': 3389,
'fromport': 3389,
'protocol': 'tcp',
'id': 116,
'cidrIp': '0.0.0.0/0'
},
{
'toport': 8443,
'fromport': 8443,
'protocol': 'tcp',
'id': 117,
'cidrIp': '0.0.0.0/0'
},
{
'toport': 22,
'fromport': 22,
'protocol': 'tcp',
'id': 118,
'cidrIp': '0.0.0.0/0'
}
],
"name": "group2012Apr30_9J5qDwOIo",
"account_number": "test_account_901265",
"servers": ["test-server-0011", "test-server-0024"]
}
}
}</nowiki>

'''Failure while trying to make unauthorized access'''
:'''POST''' http(s)://{api_server}/os-security-groups

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded fake_authentication_string

''Response Code:''
<pre>HTTP/1.1 401 Unauthorized</pre>

''Response Body:''
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.

[[Category:Hostway API]]
[[Category:FlexCloud Server API]]

List Volumes Detail

2013-06-27T01:02:53Z

Administrator:

This operation will return a list of all existing volumes with detailed information.

='''GET''' /volumes/detail'''=
This operation will return a list of all existing volumes with detailed information.

== Result ==
=== JSON ===
<nowiki>
{
"volumes" : [
{
"id": "{volume_id}",
"display_name" : "{display_volume_name}",
"display_description" : "{display_volume_description}",
"size" : "{volume_size_quantity}",
"volume_type" : "{volume_type_id}",
"metadata" : {},
"availability_zone" : "{availability_zone_id}",
"attachments": [],
"links": [
{
"href": "http://{api_server}/volumes/{volume_id}/",
"rel": "self"
}
],
"snapshot_id": "",
"created_at": "2012-05-03 11:35:44"
},
{
"id": "{volume_id}",
"display_name" : "{display_volume_name}",
"display_description" : "{display_volume_description}",
"size" : "{volume_size_quantity}",
"volume_type" : "{volume_type_id}",
"metadata" : {},
"availability_zone" : "{availability_zone_id}",
"attachments": [],
"links": [
{
"href": "http://{api_server}/volumes/{volume_id}/",
"rel": "self"
}
],
"snapshot_id": "",
"created_at": "2012-05-03 11:19:39"
}
]
}
</nowiki>

====volumes====
; id - ''string''
: Identifier of the volume instance.

; display_name - ''string''
: Display name for this volume.

; display_description - ''string''
: Descriptive information for this volume.

; size - ''string''
: Volume size in GB.

; volume_type - ''string''
: Identifier of the volume type used. *(Not used in the current version).

; metadata - ''string''
: Additional metadata info.

; availability_zone - ''string''
: Identifier of the availability zone into which this volume was created.

; attachments - ''list''
: List of attachments this volume is associated with.

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

; snapshot_id - ''string''
: Identifier of the snapshot associated with this volume if exists.

; created_at - ''string''
: Volume creation timestamp.

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

== Examples ==
'''Successfully list existing volumes with detailed information'''
:'''GET''' http(s)://{api_server}/volumes/detail

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

''Response Body:''
<nowiki>
{
"volumes" : [
{
"display_name": "vol-test-003",
"attachments": [],
"links": [
{
"href": "http://{api_server}/volumes/hbs2012May03_0OxRg0Jz7/",
"rel": "self"
}
],
"availability_zone": "test_zone",
"created_at": "2012-05-03 11:35:44",
"volume_type": "",
"display_description": "Another test volume.",
"snapshot_id": "",
"metadata": {},
"id": "hbs2012May03_0OxRg0Jz7",
"size": "30GB"
},
{
"display_name": "vol-test-001",
"attachments": [],
"links": [
{
"href": "http://{api_server}/volumes/hbs2012Apr20_NrznxEeq9/",
"rel": "self"
}
],
"availability_zone": "TEST001",
"created_at": "2012-04-20 16:48:15",
"volume_type": "",
"display_description": "Test volume 001.",
"snapshot_id": "",
"metadata": {},
"id": "hbs2012Apr20_NrznxEeq9",
"size": "10GB"
}
]
}
</nowiki>

'''Failure while trying to make an unauthorized request'''
:'''GET''' http(s)://{api_server}/volumes/detail

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded fake_authentication_string

''Response Code:''
<pre>HTTP/1.1 401 Unauthorized</pre>

''Response Body:''
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.

[[Category:Hostway API]]
[[Category:FlexCloud Server API]]

Allocate Flexible IP

2013-06-27T01:01:48Z

Administrator: /* POST /os-floating-ips */

A Flexible IP address is a static IP address that can be bound to any single Server. When you associate a flexible IP with a Server the IP is bound to that Server's network interface. You will use your flexible IP to connect to your Server. You can allocate IPs and release IPs from your account as needed.

='''POST''' /os-floating-ips=
This operation will allocate a new flexible IP.

== Request ==
<nowiki>
{
"zone": "AUS001"
}</nowiki>

== Response ==
=== JSON ===
<nowiki>
{
"floating_ip" : {
"instance_id" : "{instance_id}",
"ip" : "{ip_address}",
"fixed_ip" : null,
"links" : [
{
"href" : "http://{api_server}/os-floating-ips/{ip_address}/",
"rel" : "self"
}
],
"pool" : "default"
}
}</nowiki>

====floating_ip====
; instance_id - ''string''
: Unique instance identifier floating IP is assigned to.

; ip - ''string''
: IP address allocated.

; fixed_ip - ''string''
: Fixed IP address.

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

; pool - ''string''
: Name of the pool IP address belongs to.

== Response Codes ==
; Success
: ''HTTP/1.1 202 Accepted''

; Failure
: ''HTTP/1.1 401 Unauthorized'' : This server could not verify that you are authorized to access the document you requested. Either you supplied incorrect credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.

== Examples ==
'''Successfully allocate a flexible IP'''
:'''POST''' http(s)://{api_server}/os-floating-ips

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''Response Code:''
<pre>HTTP/1.1 202 Accepted</pre>

''Response Body:''
<nowiki>
{
"floating_ip" : {
"instance_id" : null,
"ip" : "{ip_address}",
"fixed_ip" : null,
"links" : [
{
"href" : "http://{api_server}/os-floating-ips/{ip_address}/",
"rel" : "self"
}
],
"pool" : "default"
}
}
</nowiki>

'''Unauthorized access'''
:'''POST''' <nowiki>http://{api_server}/os-floating-ips</nowiki>

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded fake_authentication_string

''Response Code:''
<pre>HTTP/1.1 401 Unauthorized</pre>

''Response Body:''
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.

[[Category:Hostway API]]
[[Category:FlexCloud Server API]]

ServerSnapshotActions

2013-06-27T01:00:01Z

Administrator: /* Restore */

The following action can be performed on a [[ServerSnapshot]].

== Restore ==
This operation will restore a server from a snapshot.
[[ServerSnapshotActionRestore]]

{{disqus}}
[[Category:Hostway API]]
[[Category:FlexCloud Server API]]

DetachVolumeFromServer

2013-06-27T00:58:37Z

Administrator:

This operation will detach a volume attachment from the server specified.

='''DELETE''' /servers/'''server_id'''/os-volume_attachments/'''volume_id'''''=

== Parameters ==
; server_id
: The unique identifier of the server.

; volume_id
: The unique volume identifier.

== Response Codes ==
; Success:
:''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 incorrect credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.
:''HTTP/1.1 404 Not Found'' - The resource does not exist.

== Examples ==
'''Successfully detach a server's volume attachment'''
:'''DELETE''' http(s)://{api_server}/servers/test-server-0013/os-volume_attachments/hbs2012May03_0OxRg0Jz7

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

'''Failure while trying to detach a volume attachment that does not exist'''
:'''GET''' http(s)://{api_server}/servers/test-server-0013/os-volume_attachments/fake_volume_id

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

''Response Body:''
{
"itemNotFound":
{
"message": "Resource not found",
"code": 404,
"details": "",
"errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
}
}

'''Failure while trying to detach a volume attachment for a server that does not exist'''
:'''DELETE''' http(s)://{api_server}/servers/fake_server_id/os-volume_attachments/hbs2012May03_0OxRg0Jz7

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

''Response Body:''
{
"itemNotFound":
{
"message": "Resource not found",
"code": 404,
"details": "",
"errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
}
}

'''Unauthorized request'''
:'''DELETE''' http(s)://{api_server}/servers/test-server-0013/os-volume_attachments/hbs2012May03_0OxRg0Jz7

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded fake_authentication_string

''Response Code:''
<pre>HTTP/1.1 401 Unauthorized</pre>

''Response Body:''
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.

[[Category:Hostway API]]
[[Category:FlexCloud Server API]]

ListVolumeDetailsForServerVolumeAttachment

2013-06-27T00:58:13Z

Administrator:

This operation will return volume details for the specific server's volume attachment.

='''GET''' /servers/'''server_id'''/os-volume_attachments/'''volume_id'''''=

== Parameters ==
; server_id
: The unique identifier of the server.

; volume_id
: The unique volume identifier.

== Result ==
=== JSON ===
<nowiki>
{
"volume" : {
"id": "{volume_id}",
"display_name" : "{display_volume_name}",
"display_description" : "{display_volume_description}",
"size" : {size_quantity},
"volume_type" : "{volume_type_id}",
"metadata" : {},
"availability_zone" : "{availability_zone_id}",
"attachments": [],
"links": [
{
"href": "http://{api_server}/volumes/{volume_id}/",
"rel": "self"
}
],
"snapshot_id": "",
"created_at": "2012-05-03 11:35:44"
}
}
</nowiki>

====volume====
; id - ''string''
: Identifier of the volume instance.

; display_name - ''string''
: Display name for this volume.

; display_description - ''string''
: Descriptive information for this volume.

; size - ''int''
: Volume size.

; volume_type - ''string''
: Identifier of the volume type used. *(Not used in the current version).

; metadata - ''string''
: Additional metadata info.

; availability_zone - ''string''
: Identifier of the availability zone into which this volume was created.

; attachments - ''list''
: List of attachments this volume is associated with.

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

; snapshot_id - ''string''
: Identifier of the snapshot associated with this volume if exists.

; created_at - ''string''
: Volume creation timestamp.

== 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 incorrect credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.
:''HTTP/1.1 404 Not Found'' - The resource does not exist.

== Examples ==
'''Successfully get volume details for a server volume attachment'''
:'''GET''' http(s)://{api_server}/servers/test-server-0013/os-volume_attachments/hbs2012May03_0OxRg0Jz7

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

''Response Body:''
<nowiki>
{
"volume": {
"display_name": "vol-test-003",
"attachments": [],
"links": [
{
"href": "http://{api_server}/volumes/hbs2012May03_0OxRg0Jz7/",
"rel": "self"
}
],
"availability_zone": "test_zone",
"created_at": "2012-05-03 11:35:44",
"volume_type": "",
"display_description": "Another test volume.",
"snapshot_id": "",
"metadata": {},
"id": "hbs2012May03_0OxRg0Jz7",
"size": "30GB"
}
}
</nowiki>

'''Failure while trying to get volume details for a volume that does not exist'''
:'''GET''' http(s)://{api_server}/servers/test-server-0013/os-volume_attachments/fake_volume_id

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

''Response Body:''
{
"itemNotFound":
{
"message": "Resource not found",
"code": 404,
"details": "",
"errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
}
}

'''Failure while trying to get volume details for a server that does not exist'''
:'''GET''' http(s)://{api_server}/servers/fake_server_id/os-volume_attachments/hbs2012May03_0OxRg0Jz7

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

''Response Body:''
{
"itemNotFound":
{
"message": "Resource not found",
"code": 404,
"details": "",
"errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
}
}
'''Unauthorized request'''
:'''GET''' http(s)://{api_server}/servers/test-server-0013/os-volume_attachments/hbs2012May03_0OxRg0Jz7

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded fake_authentication_string

''Response Code:''
<pre>HTTP/1.1 401 Unauthorized</pre>

''Response Body:''
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.

[[Category:Hostway API]]
[[Category:FlexCloud Server API]]

ServerList

2013-06-27T00:56:24Z

Administrator:

This operation will return a list of all [[Server|servers]].

='''GET''' /servers?''name=serverName&status=serverStatus&image=imageRef&zone=zoneTextKey''=

== Parameters ==
; name - ''string''
: ''Optional'' Server name to search for.

; status - ''string''
: ''Optional'' Server status to search for. Values: '''BUILD''', '''ACTIVE''', '''SUSPENDED''', '''DELETED''', '''UNKNOWN'''

; image - ''string''
: ''Optional'' Absolute URL of the image to filter servers by. ''e.g. http(s)://{api_server}/images/{image_id}/''

; zone - ''string''
: ''Optional'' Zone textkey

== Result ==
=== JSON ===
<nowiki>
{
"servers":[
{
"id":"{server_id}",
"zone": "{zone_textkey}",
"links":[
{
"href":"http://{api_server}/servers/{server_id}/",
"rel":"self"
}
]
},
{
"id":"{server_id}",
"zone": "{zone_textkey}",
"links":[
{
"href":"http://{api_server}/servers/{server_id}/",
"rel":"self"
}
]
}
]
}</nowiki>

; id - ''string''
: Unique identifier for this server.

; zone
: Zone text key

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

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

== Examples ==
'''Successfully list servers'''
:'''GET''' http(s)://{api_server}/servers

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

''Response Body:''
<nowiki>
{
"servers" : [
{
"id": "test_server_0001",
"zone": "AUS001",
"links": [
{
"href": "http://{api_server}/servers/test_server_0001/",
"rel": "self"
}
]
},
{
"id": "test_server_0013",
"zone": "zone",
"links": [
{
"href": "http://{api_server}/servers/test_server_0013/",
"rel": "self"
}
]
},
{
"id": "test_server_0015",
"zone": "AUS001",
"links": [
{
"href": "http://{api_server}/servers/test_server_0015/",
"rel": "self"
}
]
}
]
}</nowiki>

'''Failure while trying to make unauthorized access'''
:'''GET''' <nowiki>http://{api_server}/servers</nowiki>

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded fake_authentication_string

''Response Code:''
<pre>HTTP/1.1 401 Unauthorized</pre>

''Response Body:''
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.

[[Category:Hostway API]]
[[Category:FlexCloud Server API]]

Zone

2013-06-27T00:54:43Z

Administrator: /* GET /zones */

= GET /zones =
This operation will return all available zones for the authorized user.
__TOC__
== Request ==
<code>GET /zones</code>

== Response ==

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

; 401 Unauthorized
: Failure - 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.

; 403 Forbidden
: Failure - The resource is forbidden for this user

=== Response Body ===
<nowiki>
{
"account_number":[
{
"zone": "zone_id",
"location": "zone_location"
},
{
"zone": "zone_id",
"location": "zone_location"
}
]
}
</nowiki>

==== Parameters ====
; account_number - ''string''
: Account for which the zones are available. There can be several accounts per response.

; zone - ''string''
: Zone Id.

; location - ''string''
: Location of the zone.

== Examples ==

=== Successfully get the zones ===
'''Request'''
<nowiki>
GET /zones
Authorization: Basic {Base64-encoded username:password string}
</nowiki>

'''Response'''
<nowiki>
200 OK

{
"smith1234":[
{
"zone": "USOTE-2012-TAMPA",
"location": "ote.2012.tampa"
}
]
}
</nowiki>

=== Failure while trying to make an unauthorized request ===
'''Request'''
<nowiki>
GET /zones
Authorization: Basic {invalid authorization}
</nowiki>

'''Response'''
<nowiki>
401 Unauthorized
</nowiki>

=== Permission denied failure ===
'''Request'''
<nowiki>
GET /zones
Authorization: Basic {Base64-encoded username:password string}
</nowiki>

'''Response'''
<nowiki>
403 Forbidden

{
"forbidden": {
"message": "forbidden",
"code": 403,
"details": "",
"errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
}
}
</nowiki>

== See also ==
* [[FlexCloud Server|FlexCloud Server API]]
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:FlexCloud Server API]]

Image

2013-06-27T00:54:09Z

Administrator: /* GET /images/{id} */

= GET /images/''{id}'' =
This operation will return details for a single image.
__TOC__
== Request ==
<code>GET /images/''{id}''</code>

=== Parameters ===
; id
: The unique identifier of the image to be retrieved. ''Note see warnings in [[Hypermedia]]''.

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

; 403 Forbidden
; The resource is forbidden for this user

; 404 Not Found
: The resource does not exist

=== Response Body ===
<nowiki>
{
"image":{
"status":"SAVING",
"updated":null,
"name":"{display_image_name}",
"links":[
{"href":"</nowiki>{{APIBaseURL}}<nowiki>/images/{image_id}/", "rel":"self"},
{"href":"</nowiki>{{APIBaseURL}}<nowiki>/images/{image_id}/", "rel":"bookmark"}
],
"created":"yyyy-mm-ddThh:mm:ss",
"id":"{image_id}",
"zones":["{zone_id}"]
}
}
</nowiki>

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

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

; name - ''string''
: Display name for this image.

; status - ''string''
: Current state of this image. Valid values are ACTIVE, SAVING, DELETED.
:: '''ACTIVE''' - Image is ready to be used.
:: '''SAVING''' - Image is being uploaded or saved from a running [[Server]] instance.
:: '''DELETED''' - Image was recently deleted or is in the process of being deleted.

; created - ''string''
: The date and time the image was created. ISO 8601 format, YYYY-MM-DDTHH:MM:SS.

; updated
: Unused always null.

; zones - ''string''
: Zones where the image is available.

== Examples ==

=== Successfully view image ===
'''Request'''
<nowiki>
GET /images/133
Authorization: Basic {Base64-encoded username:password string}
</nowiki>

'''Response'''
<nowiki>
200 OK

{
"image": {
"status": "SAVING",
"updated": null,
"name": "test_debian_image",
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/images/133/", "rel": "self"},
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/images/133/", "rel": "bookmark"}
],
"created": "2011-09-30T02:38:57",
"id": "133",
"zones": ["AUS001"]
}
}
</nowiki>

=== Failure while trying to make an unauthorized request ===
'''Request'''
<nowiki>
GET /images/133
Authorization: Basic {invalid authorization}
</nowiki>

'''Response'''
<nowiki>
401 Unauthorized
</nowiki>

=== Permission denied failure ===
'''Request'''
<nowiki>
GET /images/122
Authorization: Basic {Base64-encoded username:password string}
</nowiki>

'''Response'''
<nowiki>
403 Forbidden

{
"forbidden": {
"message": "forbidden",
"code": 403,
"details": "",
"errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
}
}
</nowiki>

=== Failure while trying to request for an image that does not exist ===
'''Request'''
<nowiki>
GET /images/missing_image_id
Authorization: Basic {Base64-encoded username:password string}
</nowiki>

'''Response'''
<nowiki>
404 Not Found

{
"itemNotFound": {
"message": "Resource not found",
"code": 404,
"details": "",
"errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
}
}
</nowiki>

== See also ==
* [[FlexCloud Server|FlexCloud Server API]]
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:FlexCloud Server API]]

ImageList

2013-06-27T00:53:33Z

Administrator: /* GET /images?name={imageName}&status={imageStatus}&type={imageType}&zone={zoneId} */

= GET /images?name=''{imageName}''&status=''{imageStatus}''&type=''{imageType}''&zone=''{zoneId}'' =
This operation will list all images.
__TOC__
== Request ==
<code>GET /images?name=''{imageName}''&status=''{imageStatus}''&type=''{imageType}''&zone=''{zoneId}''</code>

=== Parameters ===
; name - ''string''
: ''Optional'' image name to search for.

; status - ''string''
: ''Optional'' Image status to search for. Values: '''ACTIVE''', '''SAVING''', '''DELETED'''.

; type - ''string''
: ''Optional'' type of the image to search for. Values: '''BASE''', '''SERVER'''.

; zone - ''string''
: ''Optional'' the zone where the image is available.

== Response ==

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

; 401 Unauthorized
: Failure - 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.

=== Response Body ===
<nowiki>
{
"images":[
{
"name":"{display_image_name}",
"links":[
{"href":"</nowiki>{{APIBaseURL}}<nowiki>/images/{image_id}/", "rel":"self"},
{"href":"</nowiki>{{APIBaseURL}}<nowiki>/images/{image_id}/", "rel":"bookmark"}
],
"id": "{image_id}",
"zones": ["{zone_id_1}", "{zone_id_2}"]
},
{
"name":"{display_image_name}",
"links":[
{"href":"</nowiki>{{APIBaseURL}}<nowiki>/images/{image_id}/", "rel":"self"},
{"href":"</nowiki>{{APIBaseURL}}<nowiki>/images/{image_id}/", "rel":"bookmark"}
],
"id":"{image_id}",
"zones": ["{zone_id}"]
}
]
}
</nowiki>

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

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

; name - ''string''
: Display name for this image.

; zones - ''string''
: Zones where the image is available.

== Examples ==

=== Successfully list images ===
'''Request'''
<nowiki>
GET /images
Authorization: Basic {Base64-encoded username:password string}
</nowiki>

'''Response'''
<nowiki>
200 OK

{
"images": [
{
"name": "test_public_image",
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/images/123/", "rel": "self"},
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/images/123/", "rel": "bookmark"}
],
"id": "123",
"zones": ["AUS001"]
},
{
"name": "test_debian_image",
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/images/290/", "rel": "self"},
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/images/290/", "rel": "bookmark"}
],
"id": "290",
"zones": ["AUS001"]
},
{
"name": "test_private_image",
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/images/233/", "rel": "self"},
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/images/233/", "rel": "bookmark"}
],
"id": "233",
"zones": ["AUS001"]
}
]
}
</nowiki>

=== Failure while trying to make an unauthorized request ===
'''Request'''
<nowiki>
GET /images
Authorization: Basic {invalid authorization}
</nowiki>

'''Response'''
<nowiki>
401 Unauthorized
</nowiki>

== See also ==
* [[FlexCloud Server|FlexCloud Server API]]
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:FlexCloud Server API]]

FlavorList

2013-06-27T00:52:44Z

Administrator: /* GET /flavors?minDisk={diskInGB}&minRam={ramInMB} */

= GET /flavors?minDisk=''{diskInGB}''&minRam=''{ramInMB}'' =
This operation will list all available flavors optionally limited by the query parameters.
__TOC__
== Request ==
<code>GET /flavors?minDisk=''{diskInGB}''&minRam=''{ramInMB}''</code>

=== URI Parameters ===
; minDisk - ''int''
: ''Optional'' Only flavors with a disk size greater than or equal to minDisk will be returned. Specified in GB.

; minRam - ''int''
: ''Optional'' Only flavors with a memory size greater than or equal to minRam will be returned. Specified in MB.

''Also see [[Pagination]]''

== Response ==

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

; 401 Unauthorized
: Failure - 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.

=== Response Body ===
<nowiki>
{
"flavors":[
{
"id":"{flavor_id}",
"links":[
{"href":"</nowiki>{{APIBaseURL}}<nowiki>/flavors/{flavor_id}/", "rel":"self"}
],
"name":"{display_flavor_name}"
},
{
"id":"{flavor_id}",
"links":[
{"href":"</nowiki>{{APIBaseURL}}<nowiki>/flavors/{flavor_id}/", "rel":"self"}
],
"name":"{display_flavor_name}"
}
]
}
</nowiki>

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

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

; name - ''string''
: Display name for this flavor.

== Examples ==

=== Successfully list available flavors ===
'''Request'''
<nowiki>
GET /flavors
Authorization: Basic {Base64-encoded username:password string}
</nowiki>

'''Response'''
<nowiki>
200 OK

{
"flavors": [
{
"name": "Small",
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/flavors/1/", "rel": "self"},
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/flavors/1/", "rel": "bookmark"}
],
"id": "1"
},
{
"name": "Large",
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/flavors/3/", "rel": "self"},
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/flavors/3/", "rel": "bookmark"}
],
"id": "3"
}
]
}
</nowiki>

=== Failure while trying to make an unauthorized request ===
'''Request'''
<nowiki>
GET /flavors
Authorization: Basic {invalid authorization}
</nowiki>

'''Response'''
<nowiki>
401 Unauthorized
</nowiki>

== See also ==
* [[FlexCloud Server|FlexCloud Server API]]
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:FlexCloud Server API]]

FlexCloud Server

2013-06-27T00:49:31Z

Administrator: /* Zone */

= FlexCloud Server API =
FlexCloud Server is a web service that provides compute capacity in the cloud. It is designed to allow you to quickly scale capacity as your computing requirements change. You can setup and provision [[Server]] Instances and other computing resources in minutes programmatically via the FlexCloud Server API. You have full control over your computing resources and you only pay for what you use.

The base URL for the FlexCloud Server API https://api.hostwayenterprise.com/

__TOC__
[{{fullurl:{{FULLPAGENAMEE}}|action=pdfbook}} download this selection of articles as a PDF book]

'''Please feel free to post any feedback and/or questions you may have in the “Comments” section on the bottom of each page.'''

== Flavor ==
A Flavor is a set of resource constraints including RAM, disk size and number of CPUs. They are used to describe [[Server]], [[ServerListDetails]] and [[ServerCreate]].
* [[FlavorList]]
* [[FlavorListDetails]]
* [[Flavor]]

== Image ==
An Image is a disk template that is used to create new servers [[ServerCreate]]. They are also used to inspect running [[ServerListDetails]] and [[Server]] instances.
* [[ImageList]]
* [[ImageListDetails]]
* [[Image]]

== Zone ==
A Zone specifies the region or location where cloud resources reside.
* [[Zone]]

== Server ==
A Server is a virtual machine instance in the cloud infrastructure. [[Flavor]], [[Image]] and [[Zone]] are requisite elements when creating a server.
* [[ServerList]]
* [[ServerListDetails]]
* [[Server]]
* [[ServerCreate]]
* [[ServerActions]]
**[[ServerActionReboot]]
**[[ServerActionStop]]
**[[ServerActionStart]]
**[[ServerActionResize]]
**[[ServerActionAddFlexibleIP]]
**[[ServerActionRemoveFlexibleIP]]
**[[ServerActionUpgradePlesk]]
* [[ListServerIPs]]
* [[AttachVolumeToServer]]
* [[ListVolumeAttachmentsForServer]]
* [[ListVolumeDetailsForServerVolumeAttachment]]
* [[DetachVolumeFromServer]]
* [[ServerMonitoringDetails]]
**[[ServerMonitoringDetailsCPU]]
**[[ServerMonitoringDetailsDisk]]
**[[ServerMonitoringDetailsBandwidth]]
* [[ServerSnapshotList]]
* [[ServerSnapshot]]
* [[ServerSnapshotCreate]]
* [[ServerSnapshotActions]]
** [[ServerSnapshotActionRestore]]

== Flexible IP ==
A Flexible IP address is a static IP address that can be bound to any single Server. When you associate a flexible IP with a Server the IP is bound to that Server's network interface. You will use your flexible IP to connect to your Server. You can allocate IPs and release IPs from your account as needed.
* [[Allocate Flexible IP]]
* [[List Flexible IPs]]
* [[View Allocated Flexible IP]]
* [[Delete Allocated Flexible IP]]

== Volume ==
A Volume provides storage space that can be used with your Server. This storage space is independent from the storage space that is included with your Server. Once a volume is created, it can be easily attached to a Server. Once attached, it will appear as a mounted device. You can attach multiple volumes to a Server.
* [[Create Volume]]
* [[View Single Volume]]
* [[List Volumes]]
* [[List Volumes Detail]]
* [[Delete Volume]]

== Security/Firewall Group ==
A Security/Firewall Group defines firewall rules for your Server. You have the ability to configure your firewall connections and secure your network as required. You may have one or multiple servers behind a firewall group. Hostway provides a default firewall group, and typical firewall rules are already configured. You can create multiple firewall groups as needed.
* [[Create Firewall Group]]
* [[List Firewall Groups]]
* [[View Firewall Group Details]]
* [[Delete Firewall Group]]
* [[Create Firewall Group Rule]]
* [[Delete Firewall Group Rule]]

== See also ==
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:FlexCloud Server API]]

FlexCloud Server

2013-06-27T00:49:13Z

Administrator: /* Zone */

= FlexCloud Server API =
FlexCloud Server is a web service that provides compute capacity in the cloud. It is designed to allow you to quickly scale capacity as your computing requirements change. You can setup and provision [[Server]] Instances and other computing resources in minutes programmatically via the FlexCloud Server API. You have full control over your computing resources and you only pay for what you use.

The base URL for the FlexCloud Server API https://api.hostwayenterprise.com/

__TOC__
[{{fullurl:{{FULLPAGENAMEE}}|action=pdfbook}} download this selection of articles as a PDF book]

'''Please feel free to post any feedback and/or questions you may have in the “Comments” section on the bottom of each page.'''

== Flavor ==
A Flavor is a set of resource constraints including RAM, disk size and number of CPUs. They are used to describe [[Server]], [[ServerListDetails]] and [[ServerCreate]].
* [[FlavorList]]
* [[FlavorListDetails]]
* [[Flavor]]

== Image ==
An Image is a disk template that is used to create new servers [[ServerCreate]]. They are also used to inspect running [[ServerListDetails]] and [[Server]] instances.
* [[ImageList]]
* [[ImageListDetails]]
* [[Image]]

== Zone ==
A zone specifies the region or location where cloud resources reside.
* [[Zone]]

== Server ==
A Server is a virtual machine instance in the cloud infrastructure. [[Flavor]], [[Image]] and [[Zone]] are requisite elements when creating a server.
* [[ServerList]]
* [[ServerListDetails]]
* [[Server]]
* [[ServerCreate]]
* [[ServerActions]]
**[[ServerActionReboot]]
**[[ServerActionStop]]
**[[ServerActionStart]]
**[[ServerActionResize]]
**[[ServerActionAddFlexibleIP]]
**[[ServerActionRemoveFlexibleIP]]
**[[ServerActionUpgradePlesk]]
* [[ListServerIPs]]
* [[AttachVolumeToServer]]
* [[ListVolumeAttachmentsForServer]]
* [[ListVolumeDetailsForServerVolumeAttachment]]
* [[DetachVolumeFromServer]]
* [[ServerMonitoringDetails]]
**[[ServerMonitoringDetailsCPU]]
**[[ServerMonitoringDetailsDisk]]
**[[ServerMonitoringDetailsBandwidth]]
* [[ServerSnapshotList]]
* [[ServerSnapshot]]
* [[ServerSnapshotCreate]]
* [[ServerSnapshotActions]]
** [[ServerSnapshotActionRestore]]

== Flexible IP ==
A Flexible IP address is a static IP address that can be bound to any single Server. When you associate a flexible IP with a Server the IP is bound to that Server's network interface. You will use your flexible IP to connect to your Server. You can allocate IPs and release IPs from your account as needed.
* [[Allocate Flexible IP]]
* [[List Flexible IPs]]
* [[View Allocated Flexible IP]]
* [[Delete Allocated Flexible IP]]

== Volume ==
A Volume provides storage space that can be used with your Server. This storage space is independent from the storage space that is included with your Server. Once a volume is created, it can be easily attached to a Server. Once attached, it will appear as a mounted device. You can attach multiple volumes to a Server.
* [[Create Volume]]
* [[View Single Volume]]
* [[List Volumes]]
* [[List Volumes Detail]]
* [[Delete Volume]]

== Security/Firewall Group ==
A Security/Firewall Group defines firewall rules for your Server. You have the ability to configure your firewall connections and secure your network as required. You may have one or multiple servers behind a firewall group. Hostway provides a default firewall group, and typical firewall rules are already configured. You can create multiple firewall groups as needed.
* [[Create Firewall Group]]
* [[List Firewall Groups]]
* [[View Firewall Group Details]]
* [[Delete Firewall Group]]
* [[Create Firewall Group Rule]]
* [[Delete Firewall Group Rule]]

== See also ==
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:FlexCloud Server API]]

Products

2013-04-15T04:03:29Z

Administrator:

= Product Catalog API =
The product catalog API provides acces to information about the current product offerings.
__TOC__
[{{fullurl:{{FULLPAGENAMEE}}|action=pdfbook}} download this selection of articles as a PDF book]

== Product Specifications ==
Product specifications are the high-level entities that can be purchased. A product specification includes open or more service specifications, describing the services provided with the product. Each product specification is offered in one or more ways, described by the included product offerings.

* [[ProductSpecifications:GET|GET /productSpecifications]] - Returns list of product specifications
* [[ProductSpecifications-productSpecificationId:GET|GET /productSpecifications/{productSpecificationId}]] - Returns details of single product specification

== Product Offerings ==
The product offerings describe the terms under which a product is being offered. This includes the currency, billing period, etc.

* [[ProductSpecifications-productSpecificationId-offerings:GET|GET /productSpecifications/{productSpecificationId}/offerings]] - Returns all offerings for a product specification
* [[ProductSpecifications-productSpecificationId-offerings-offeringId:GET|GET /productSpecifications/{productSpecificationId}/offerings/{offeringId}]] - Returns details about a product specification offering
* [[ProductSpecifications-productSpecificationId-offerings-offeringId-prices:GET|GET /productSpecifications/{productSpecificationId}/offerings/{offeringId}/prices]] - Returns all prices for a product specification offering

== Service Specifications ==
Service specifications provide details about the services offered with a product.

* [[ProductSpecifications-productSpecificationId-serviceSpecifications:GET|GET /productSpecifications/{productSpecificationId}/serviceSpecifications]] - Returns all service specifications for a product
* [[ServiceSpecifications-serviceSpecificationId:GET|GET /serviceSpecifications/{serviceSpecificationId}]] - Returns service specification details
* [[ServiceSpecifications-serviceSpecificationId-attributes:GET|GET /serviceSpecifications/{serviceSpecificationId}/attributes]] - Returns service specification attributes

== See also ==
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Product Catalog API]]

Delete Firewall Group Rule

2013-04-13T01:40:23Z

Administrator:

This operation will delete a firewall group rule.

=='''DELETE''' /os-security-group-rules/'''id'''==

=== Parameters ===
; id - ''string''
: The unique firewall group rule identifier.

=== Response Codes ===
; Success:
:''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 404 Not Found'' - The resource does not exist.

=== Examples ===

'''Successfully delete the specified firewall group rule'''
:'''DELETE''' http(s)://{api_server}/os-security-group-rules/{firewall_group_rule_id}

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

'''Failure while trying to delete a non-existent firewall group rule'''
:'''DELETE''' http(s)://{api_server}/os-security-group-rules/{fake_firewall_group_rule_id}

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

'''Failure while trying to make unauthorized access'''
:'''DELETE''' http(s)://{api_server}/os-security-group-rules/{firewall_group_rule_id}

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded fake_authentication_string

''Response Code:''
<pre>HTTP/1.1 401 Unauthorized</pre>

''Response Body:''
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.

[[Category:Hostway API]]
[[Category:FlexCloud Server API]]



{{#widget:DISQUS
|id=hostway
|uniqid={{PAGENAME}}
|url={{fullurl:{{PAGENAME}}}}
}}

Create Firewall Group Rule

2013-04-13T01:40:01Z

Administrator:

This operation will create a new firewall group rule.

=='''POST''' /os-security-group-rules==

=== Request ===
==== JSON ====
<nowiki>
{
"security_group_rule" : {
"from_port": {start_port},
"to_port": {end_port},
"ip_protocol": "{ip_protocol}",
"cidr": "127.0.0.1/24",
"parent_group_id": "{parent_group_id}"
}
}</nowiki>

=====security_group_rule=====
; from_port - ''int''
: Start port number.

; to_port - ''int''
: End port number.

; ip_protocol - ''string''
: IP protocol used.

; cidr - ''string''
: CIDR notation IP address.

; parent_group_id - ''string''
: Parent group identifier for this rule.

=== Response ===
==== JSON ====
<nowiki>
{
"security_group_rule" : {
"from_port": {start_port},
"group": {
"display_name": "{firewall_group_display_name}",
"name": "{firewall_group_name}",
"links": [
{
"href": "http://{api_server}/os-security-groups/{firewall_group_name}/",
"rel": "self"
}
],
"description": "{firewall_group_description}",
"account_number": "{user_account_number}",
"servers": []
},
"ip_protocol": "{ip_protocol}",
"links": [
{
"href": "http://{api_server}/os-security-group-rules/{firewall_group_rule_id}/",
"rel": "self"
}
],
"to_port": {end_port},
"parent_group_id": "{parent_firewall_group_name}",
"ip_range": {
"cidr": "127.0.0.1/24"
},
"id": {firewall_group_rule_id}
}
}
</nowiki>

=====security_group_rule=====
; from_port - ''int''
: Start port number.

; group - ''dictionary''
: Firewall group information.

; ip_protocol - ''string''
: IP protocol used.

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

; to_port - ''int''
: End port number.

; parent_group_id - ''string''
: Parent group identifier for this rule.

; ip_range - ''dictionary''
: IP range in CIDR notation.

; id - ''string''
: Firewall group rule unique identifier.

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

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

=== Examples ===
'''Successfully create a new firewall group rule'''
:'''POST''' http(s)://{api_server}//os-security-group-rules

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''Request Body:''
<nowiki>
{
"security_group_rule" : {
"from_port": 80,
"to_port": 80,
"ip_protocol": "tcp",
"cidr": "127.0.0.1/24",
"parent_group_id": "group2012May11_NpCpS3995"
}
}
</nowiki>

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

''Response Body:''
<nowiki>
{
"security_group_rule" : {
"from_port": 80,
"group": {
"display_name": "Rules Test Group",
"name": "group2012May11_NpCpS3995",
"links": [
{
"href": "http://{api_server}/os-security-groups/group2012May11_NpCpS3995/",
"rel": "self"
}
],
"description": "A firewall group created from test",
"account_number": "test_account_718912",
"servers": []
},
"ip_protocol": "tcp",
"links": [
{
"href": "http://{api_server}/os-security-group-rules/214/",
"rel": "self"
}
],
"to_port": 80,
"parent_group_id": "group2012May11_NpCpS3995",
"ip_range": {
"cidr": "127.0.0.1/24"
},
"id": 214
}
}
</nowiki>

'''Successfully create a new firewall group rule with an IP without a netmask'''
:'''POST''' http(s)://{api_server}//os-security-group-rules

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''Request Body:''
<nowiki>
{
"security_group_rule" : {
"from_port": 80,
"to_port": 80,
"ip_protocol": "tcp",
"cidr": "127.0.0.1",
"parent_group_id": "group2012May11_NpCpS3995"
}
}
</nowiki>

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

''Response Body:''
<nowiki>
{
"security_group_rule" : {
"from_port": 80,
"group": {
"display_name": "Rules Test Group",
"name": "group2012May11_NpCpS3995",
"links": [
{
"href": "http://{api_server}/os-security-groups/group2012May11_NpCpS3995/",
"rel": "self"
}
],
"description": "A firewall group created from test",
"account_number": "test_account_718912",
"servers": []
},
"ip_protocol": "tcp",
"links": [
{
"href": "http://{api_server}/os-security-group-rules/215/",
"rel": "self"
}
],
"to_port": 80,
"parent_group_id": "group2012May11_NpCpS3995",
"ip_range": {
"cidr": "127.0.0.1/32"
},
"id": 215
}
}
</nowiki>

'''Failure while trying to create a new firewall group rule with invalid data'''
:'''POST''' http(s)://{api_server}/os-security-group-rules

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''Request Body:''
{
Empty
}

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

''Response Body:''
<nowiki>
{
"badRequest" : {
"message": "Invalid",
"code": 400,
"details": ""
}
}</nowiki>

'''Failure while trying to create a new rule with invalid from and to ports'''
:'''POST''' http(s)://{api_server}/os-security-group-rules

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''Request Body:''
{
"security_group_rule" : {
"from_port": 81,
"to_port": 80,
"ip_protocol": "tcp",
"cidr": "127.0.0.1/24",
"parent_group_id": "group2012May11_NpCpS3995"
}
}

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

''Response Body:''
<nowiki>
{
"badRequest" : {
"message": "FirewallRuleError",
"code": 400,
"details": "Invalid ports"
}
}</nowiki>

'''Failure while trying to create a new rule rule with an invalid protocol'''
:'''POST''' http(s)://{api_server}/os-security-group-rules

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''Request Body:''
{
"security_group_rule" : {
"from_port": 80,
"to_port": 80,
"ip_protocol": "proto",
"cidr": "127.0.0.1/24",
"parent_group_id": "group2012May11_NpCpS3995"
}
}

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

''Response Body:''
<nowiki>
{
"badRequest" : {
"message": "Invalid",
"code": 400,
"details": ""
}
}</nowiki>

'''Failure while trying to create a new firewall rule with an invalid IP address'''
:'''POST''' http(s)://{api_server}/os-security-group-rules

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''Request Body:''
{
"security_group_rule" : {
"from_port": 80,
"to_port": 80,
"ip_protocol": "tcp",
"cidr": "ip_address",
"parent_group_id": "group2012May11_NpCpS3995"
}
}

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

''Response Body:''
<nowiki>
{
"badRequest" : {
"message": "FirewallRuleError",
"code": 400,
"details": "Source IP address is invalid"
}
}</nowiki>

'''Failure while trying to make unauthorized access'''
:'''POST''' http(s)://{api_server}/os-security-groups

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded fake_authentication_string

''Response Code:''
<pre>HTTP/1.1 401 Unauthorized</pre>

''Response Body:''
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.

[[Category:Hostway API]]
[[Category:FlexCloud Server API]]



{{#widget:DISQUS
|id=hostway
|uniqid={{PAGENAME}}
|url={{fullurl:{{PAGENAME}}}}
}}

Delete Firewall Group

2013-04-13T01:39:34Z

Administrator:

This operation will delete the specified firewall group.

=='''DELETE''' /os-security-groups/'''name'''==

=== Parameters ===
; name
: The unique identifier of the firewall group.

=== Response Codes ===
; Success:
:''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 404 Not Found'' - The resource does not exist.

=== Examples ===

'''Successfully delete the specified firewall group'''
:'''DELETE''' http(s)://{api_server}/os-security-groups/group2012May11_OK30Zs7Ju

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

'''Failure while trying to make unauthorized access'''
:'''DELETE''' http(s)://{api_server}/os-security-groups/group2012May11_OK30Zs7Ju

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded fake_authentication_string

''Response Code:''
<pre>HTTP/1.1 401 Unauthorized</pre>

''Response Body:''
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.

'''Failure while trying to delete a non-existent firewall group'''
:'''DELETE''' http(s)://{api_server}/os-security-groups/{fake_firewall_group_name}

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

[[Category:Hostway API]]
[[Category:FlexCloud Server API]]



{{#widget:DISQUS
|id=hostway
|uniqid={{PAGENAME}}
|url={{fullurl:{{PAGENAME}}}}
}}

List Firewall Groups

2013-04-13T01:39:01Z

Administrator:

This operation will list all existing firewall groups.

=='''GET''' /os-security-groups==

=== Response ===
==== JSON ====
<nowiki>
{
"security_groups" : [
{
"display_name" : "{firewall_group_display_name}",
"description" : "{firewall_group_description}",
"links" : [
{
"href" : "http://{api-server}/os-security-groups/{firewall_group_name}/",
"rel" : "self"
}
],
"rules" : [
{
"fromport" : {start_port},
"toport" : {end_port},
"protocol" : "{ip_protocol}",
"cidrIp": "0.0.0.0/0",
"id" : "145"
}
]
"fault" : {
"message" : "",
"code" : "",
"details" : ""
},
"servers" : ["{server_id}"],
"account_number" : "{user_account_number}",
"name" : "{firewall_group_name}"
}
]
}
</nowiki>

=====security_groups=====
; display name - ''string''
: The display name of the firewall group.

; description - ''string''
: Text describing the firewall group.

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

; rules - ''list''
: List describing all defined security rules for the group.

; fault - ''dictionary''
: Might hold a fault information for the firewall group.

; servers - ''list''
: List of server ids this firewall group is assigned to.

; account_number - ''string''
: Identifies an account that owns the firewall group.

; name - ''string''
: The name of this firewall group.*(Unique identifier for this firewall group.)

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

=== Examples ===
'''Successfully list firewall groups'''
:'''GET''' http(s)://{api_server}/os-security-groups

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

''Response Body:''
<nowiki>
{
"security_group" : [
{
"display_name": "Test Firewall Group 1",
"description": "Test firewall group 1 description.",
"links": [
{
"href": "http://{api_server}/os-security-groups/group2012May11_OK30Zs7Ju/",
"rel": "self"
}
],
"rules": [
{
'toport': 1111,
'fromport': 1111,
'protocol': 'TCP',
'id': 145,
'cidrIp': '0.0.0.0/0'
},
{
'toport': 80,
'fromport': 80,
'protocol': 'tcp',
'id': 196,
'cidrIp': '127.0.0.1/24'
}
],
"name": "group2012May11_OK30Zs7Ju",
"account_number": "test_account_120761",
"servers": ["test-server-0003"]
},
{
"display_name": "Test Firewall Group",
"description": "Test firewall group description.",
"links": [
{
"href": "http://{api_server}/os-security-groups/group2012Apr30_9J5qDwOIo/",
"rel": "self"
}
],
"rules": [
{
'toport': 3389,
'fromport': 3389,
'protocol': 'tcp',
'id': 116,
'cidrIp': '0.0.0.0/0'
},
{
'toport': 8443,
'fromport': 8443,
'protocol': 'tcp',
'id': 117,
'cidrIp': '0.0.0.0/0'
},
{
'toport': 22,
'fromport': 22,
'protocol': 'tcp',
'id': 118,
'cidrIp': '0.0.0.0/0'
}
],
"name": "group2012Apr30_9J5qDwOIo",
"account_number": "test_account_901265",
"servers": ["test-server-0011", "test-server-0024"]
}
}
}</nowiki>

'''Failure while trying to make unauthorized access'''
:'''POST''' http(s)://{api_server}/os-security-groups

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded fake_authentication_string

''Response Code:''
<pre>HTTP/1.1 401 Unauthorized</pre>

''Response Body:''
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.

[[Category:Hostway API]]
[[Category:FlexCloud Server API]]



{{#widget:DISQUS
|id=hostway
|uniqid={{PAGENAME}}
|url={{fullurl:{{PAGENAME}}}}
}}

List Firewall Groups

2013-04-13T01:38:51Z

Administrator:

This operation will list all existing firewall groups.

=='''GET''' /os-security-groups==
This operation lists existing firewall groups.

=== Response ===
==== JSON ====
<nowiki>
{
"security_groups" : [
{
"display_name" : "{firewall_group_display_name}",
"description" : "{firewall_group_description}",
"links" : [
{
"href" : "http://{api-server}/os-security-groups/{firewall_group_name}/",
"rel" : "self"
}
],
"rules" : [
{
"fromport" : {start_port},
"toport" : {end_port},
"protocol" : "{ip_protocol}",
"cidrIp": "0.0.0.0/0",
"id" : "145"
}
]
"fault" : {
"message" : "",
"code" : "",
"details" : ""
},
"servers" : ["{server_id}"],
"account_number" : "{user_account_number}",
"name" : "{firewall_group_name}"
}
]
}
</nowiki>

=====security_groups=====
; display name - ''string''
: The display name of the firewall group.

; description - ''string''
: Text describing the firewall group.

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

; rules - ''list''
: List describing all defined security rules for the group.

; fault - ''dictionary''
: Might hold a fault information for the firewall group.

; servers - ''list''
: List of server ids this firewall group is assigned to.

; account_number - ''string''
: Identifies an account that owns the firewall group.

; name - ''string''
: The name of this firewall group.*(Unique identifier for this firewall group.)

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

=== Examples ===
'''Successfully list firewall groups'''
:'''GET''' http(s)://{api_server}/os-security-groups

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

''Response Body:''
<nowiki>
{
"security_group" : [
{
"display_name": "Test Firewall Group 1",
"description": "Test firewall group 1 description.",
"links": [
{
"href": "http://{api_server}/os-security-groups/group2012May11_OK30Zs7Ju/",
"rel": "self"
}
],
"rules": [
{
'toport': 1111,
'fromport': 1111,
'protocol': 'TCP',
'id': 145,
'cidrIp': '0.0.0.0/0'
},
{
'toport': 80,
'fromport': 80,
'protocol': 'tcp',
'id': 196,
'cidrIp': '127.0.0.1/24'
}
],
"name": "group2012May11_OK30Zs7Ju",
"account_number": "test_account_120761",
"servers": ["test-server-0003"]
},
{
"display_name": "Test Firewall Group",
"description": "Test firewall group description.",
"links": [
{
"href": "http://{api_server}/os-security-groups/group2012Apr30_9J5qDwOIo/",
"rel": "self"
}
],
"rules": [
{
'toport': 3389,
'fromport': 3389,
'protocol': 'tcp',
'id': 116,
'cidrIp': '0.0.0.0/0'
},
{
'toport': 8443,
'fromport': 8443,
'protocol': 'tcp',
'id': 117,
'cidrIp': '0.0.0.0/0'
},
{
'toport': 22,
'fromport': 22,
'protocol': 'tcp',
'id': 118,
'cidrIp': '0.0.0.0/0'
}
],
"name": "group2012Apr30_9J5qDwOIo",
"account_number": "test_account_901265",
"servers": ["test-server-0011", "test-server-0024"]
}
}
}</nowiki>

'''Failure while trying to make unauthorized access'''
:'''POST''' http(s)://{api_server}/os-security-groups

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded fake_authentication_string

''Response Code:''
<pre>HTTP/1.1 401 Unauthorized</pre>

''Response Body:''
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.

[[Category:Hostway API]]
[[Category:FlexCloud Server API]]



{{#widget:DISQUS
|id=hostway
|uniqid={{PAGENAME}}
|url={{fullurl:{{PAGENAME}}}}
}}

Delete Volume

2013-04-13T01:37:43Z

Administrator:

This operation will delete a single volume.

=='''DELETE''' /volumes/'''id'''==

=== Parameters ===
; id - ''string''
: The unique volume identifier.

=== Response Codes ===
; Success:
:''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 404 Not Found'' - The resource does not exist.

=== Examples ===

'''Successfully delete the specified volume'''
:'''DELETE''' http(s)://{api_server}/volumes/{volume_id}

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

'''Failure while trying to delete a non-existent volume'''
:'''DELETE''' http(s)://{api_server}/volumes/{fake_volume_id}

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

'''Failure while trying to make an unauthorized access'''
:'''DELETE''' http(s)://{api_server}/volumes/{volume_id}

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded fake_authentication_string

''Response Code:''
<pre>HTTP/1.1 401 Unauthorized</pre>

''Response Body:''
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.

[[Category:Hostway API]]
[[Category:FlexCloud Server API]]



{{#widget:DISQUS
|id=hostway
|uniqid={{PAGENAME}}
|url={{fullurl:{{PAGENAME}}}}
}}

List Volumes Detail

2013-04-13T01:37:14Z

Administrator:

This operation will list all existing volumes including their details.

=='''GET''' /volumes/detail'''==

=== Result ===
==== JSON ====
<nowiki>
{
"volumes" : [
{
"id": "{volume_id}",
"display_name" : "{display_volume_name}",
"display_description" : "{display_volume_description}",
"size" : "{volume_size_quantity}",
"volume_type" : "{volume_type_id}",
"metadata" : {},
"availability_zone" : "{availability_zone_id}",
"attachments": [],
"links": [
{
"href": "http://{api_server}/volumes/{volume_id}/",
"rel": "self"
}
],
"snapshot_id": "",
"created_at": "2012-05-03 11:35:44"
},
{
"id": "{volume_id}",
"display_name" : "{display_volume_name}",
"display_description" : "{display_volume_description}",
"size" : "{volume_size_quantity}",
"volume_type" : "{volume_type_id}",
"metadata" : {},
"availability_zone" : "{availability_zone_id}",
"attachments": [],
"links": [
{
"href": "http://{api_server}/volumes/{volume_id}/",
"rel": "self"
}
],
"snapshot_id": "",
"created_at": "2012-05-03 11:19:39"
}
]
}
</nowiki>

=====volumes=====
; id - ''string''
: Identifier of the volume instance.

; display_name - ''string''
: Display name for this volume.

; display_description - ''string''
: Descriptive information for this volume.

; size - ''string''
: Volume size in GB.

; volume_type - ''string''
: Identifier of the volume type used. *(Not used in the current version).

; metadata - ''string''
: Additional metadata info.

; availability_zone - ''string''
: Identifier of the availability zone into which this volume was created.

; attachments - ''list''
: List of attachments this volume is associated with.

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

; snapshot_id - ''string''
: Identifier of the snapshot associated with this volume if exists.

; created_at - ''string''
: Volume creation timestamp.

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

=== Examples ===
'''Successfully list existing volumes with detailed information'''
:'''GET''' http(s)://{api_server}/volumes/detail

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

''Response Body:''
<nowiki>
{
"volumes" : [
{
"display_name": "vol-test-003",
"attachments": [],
"links": [
{
"href": "http://{api_server}/volumes/hbs2012May03_0OxRg0Jz7/",
"rel": "self"
}
],
"availability_zone": "test_zone",
"created_at": "2012-05-03 11:35:44",
"volume_type": "",
"display_description": "Another test volume.",
"snapshot_id": "",
"metadata": {},
"id": "hbs2012May03_0OxRg0Jz7",
"size": "30GB"
},
{
"display_name": "vol-test-001",
"attachments": [],
"links": [
{
"href": "http://{api_server}/volumes/hbs2012Apr20_NrznxEeq9/",
"rel": "self"
}
],
"availability_zone": "TEST001",
"created_at": "2012-04-20 16:48:15",
"volume_type": "",
"display_description": "Test volume 001.",
"snapshot_id": "",
"metadata": {},
"id": "hbs2012Apr20_NrznxEeq9",
"size": "10GB"
}
]
}
</nowiki>

'''Failure while trying to make an unauthorized request'''
:'''GET''' http(s)://{api_server}/volumes/detail

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded fake_authentication_string

''Response Code:''
<pre>HTTP/1.1 401 Unauthorized</pre>

''Response Body:''
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.

[[Category:Hostway API]]
[[Category:FlexCloud Server API]]



{{#widget:DISQUS
|id=hostway
|uniqid={{PAGENAME}}
|url={{fullurl:{{PAGENAME}}}}
}}

View Firewall Group Details

2013-04-13T01:35:05Z

Administrator:

This operation will list the details for the specified firewall group.

=='''GET''' /os-security-groups/'''name'''==

=== Parameters ===
; name
: The unique identifier of the firewall group.

=== Response ===
==== JSON ====
<nowiki>
{
"security_group" : {
"display_name" : "{firewall_group_display_name}",
"description" : "{firewall_group_description}",
"links" : [
{
"href" : "http://{api-server}/os-security-groups/{firewall_group_name}/",
"rel" : "self"
}
],
"rules" : [
{
"fromport" : "{start_port}",
"toport" : "{end_port}",
"protocol" : "{ip_protocol}",
"cidrIp": "0.0.0.0/0",
"id" : "145"
},
{
"fromport" : "{start_port}",
"toport" : "{end_port}",
"protocol" : "{ip_protocol}",
"cidrIp": "127.0.0.1/0",
"id" : "169"
}
],
"servers" : ["{server_id}"],
"account_number" : "{user_account_number}",
"name" : "{firewall_group_name}"
}
}
</nowiki>

=====security_group=====
; display name - ''string''
: The display name of the firewall group.

; description - ''string''
: Text describing the firewall group.

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

; rules - ''list''
: List describing all defined security rules for the group.

; servers - ''list''
: List of server ids this firewall group is assigned to.

; account_number - ''string''
: Identifies an account that owns the firewall group.

; name - ''string''
: The name of this firewall group.*(Unique identifier for this firewall group.)

=== 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 404 Not Found'' - The resource does not exist.

=== Examples ===
'''Successfully list details for specified firewall group'''
:'''GET''' http(s)://{api_server}/os-security-groups/group2012May11_OK30Zs7Ju

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

''Response Body:''
<nowiki>
{
"security_group" : {
"display_name": "Test Firewall Group 1",
"description": "Test firewall group 1 description.",
"links": [
{
"href": "http://{api_server}/os-security-groups/group2012May11_OK30Zs7Ju/",
"rel": "self"
}
],
"rules": [
{
'toport': 1111,
'fromport': 1111,
'protocol': 'TCP',
'id': 145,
'cidrIp': '0.0.0.0/0'
},
{
'toport': 80,
'fromport': 80,
'protocol': 'tcp',
'id': 196,
'cidrIp': '127.0.0.1/24'
}
],
"name": "group2012May11_OK30Zs7Ju",
"account_number": "test_account_120761",
"servers": ["test-server-0003"]
}
}</nowiki>

'''Failure while trying to request details for a firewall group that does not exist'''
:'''GET''' http(s)://{api_server}/os-security-groups/{fake_firewall_group_name}

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

''Response Body:''
{
"itemNotFound":
{
"message": "Resource not found",
"code": 404,
"details": ""
}
}

'''Failure while trying to make unauthorized access'''
:'''GET''' http(s)://{api_server}/os-security-groups/group2012May11_OK30Zs7Ju

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded fake_authentication_string

''Response Code:''
<pre>HTTP/1.1 401 Unauthorized</pre>

''Response Body:''
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.

[[Category:Hostway API]]
[[Category:FlexCloud Server API]]



{{#widget:DISQUS
|id=hostway
|uniqid={{PAGENAME}}
|url={{fullurl:{{PAGENAME}}}}
}}

List Volumes

2013-04-13T01:34:30Z

Administrator:

This operation will return a list of all existing volumes.

=='''GET''' /volumes'''==

=== Result ===
==== JSON ====
<nowiki>
{
"volumes" : [
{
"id": "{volume_id}",
"display_name" : "{display_volume_name}",
"display_description" : "{display_volume_description}",
"size" : "{volume_size_quantity}",
"volume_type" : "{volume_type_id}",
"metadata" : {},
"availability_zone" : "{availability_zone_id}",
"attachments": [],
"links": [
{
"href": "http://{api_server}/volumes/{volume_id}/",
"rel": "self"
}
],
"snapshot_id": "",
"created_at": "2012-05-03 11:35:44"
},
{
"id": "{volume_id}",
"display_name" : "{display_volume_name}",
"display_description" : "{display_volume_description}",
"size" : "{volume_size_quantity}",
"volume_type" : "{volume_type_id}",
"metadata" : {},
"availability_zone" : "{availability_zone_id}",
"attachments": [],
"links": [
{
"href": "http://{api_server}/volumes/{volume_id}/",
"rel": "self"
}
],
"snapshot_id": "",
"created_at": "2012-05-03 11:19:39"
}
]
}
</nowiki>

=====volumes=====
; id - ''string''
: Identifier of the volume instance.

; display_name - ''string''
: Display name for this volume.

; display_description - ''string''
: Descriptive information for this volume.

; size - ''string''
: Volume size in GB.

; volume_type - ''string''
: Identifier of the volume type used. *(Not used in the current version).

; metadata - ''string''
: Additional metadata info.

; availability_zone - ''string''
: Identifier of the availability zone into which this volume was created.

; attachments - ''list''
: List of attachments this volume is associated with.

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

; snapshot_id - ''string''
: Identifier of the snapshot associated with this volume if exists.

; created_at - ''string''
: Volume creation timestamp.

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

=== Examples ===
'''Successfully list existing volumes'''
:'''GET''' http(s)://{api_server}/volumes

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

''Response Body:''
<nowiki>
{
"volumes" : [
{
"display_name": "vol-test-003",
"attachments": [],
"links": [
{
"href": "http://{api_server}/volumes/hbs2012May03_0OxRg0Jz7/",
"rel": "self"
}
],
"availability_zone": "test_zone",
"created_at": "2012-05-03 11:35:44",
"volume_type": "",
"display_description": "Another test volume.",
"snapshot_id": "",
"metadata": {},
"id": "hbs2012May03_0OxRg0Jz7",
"size": "30GB"
},
{
"display_name": "vol-test-001",
"attachments": [],
"links": [
{
"href": "http://{api_server}/volumes/hbs2012Apr20_NrznxEeq9/",
"rel": "self"
}
],
"availability_zone": "TEST001",
"created_at": "2012-04-20 16:48:15",
"volume_type": "",
"display_description": "Test volume 001.",
"snapshot_id": "",
"metadata": {},
"id": "hbs2012Apr20_NrznxEeq9",
"size": "10GB"
}
]
}
</nowiki>

'''Failure while trying to make an unauthorized request'''
:'''GET''' http(s)://{api_server}/volumes

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded fake_authentication_string

''Response Code:''
<pre>HTTP/1.1 401 Unauthorized</pre>

''Response Body:''
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.

[[Category:Hostway API]]
[[Category:FlexCloud Server API]]



{{#widget:DISQUS
|id=hostway
|uniqid={{PAGENAME}}
|url={{fullurl:{{PAGENAME}}}}
}}

View Single Volume

2013-04-13T01:34:00Z

Administrator:

This operation will return details of a single volume.

=='''GET''' /volumes/'''id'''==

=== Request Parameters ===
; id
: The unique identifier of the volume.

=== Result ===
==== JSON ====
<nowiki>
{
"volume" : {
"id": "{volume_id}",
"display_name" : "{display_volume_name}",
"display_description" : "{display_volume_description}",
"size" : {size_quantity},
"volume_type" : "{volume_type_id}",
"metadata" : {},
"availability_zone" : "{availability_zone_id}",
"attachments": [],
"links": [
{
"href": "http://{api_server}/volumes/{volume_id}/",
"rel": "self"
}
],
"snapshot_id": "",
"created_at": "2012-05-03 11:35:44"
}
}
</nowiki>

=====volume=====
; id - ''string''
: Identifier of the volume instance.

; display_name - ''string''
: Display name for this volume.

; display_description - ''string''
: Descriptive information for this volume.

; size - ''int''
: Volume size.

; volume_type - ''string''
: Identifier of the volume type used. *(Not used in the current version).

; metadata - ''string''
: Additional metadata info.

; availability_zone - ''string''
: Identifier of the availability zone into which this volume was created.

; attachments - ''list''
: List of attachments this volume is associated with.

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

; snapshot_id - ''string''
: Identifier of the snapshot associated with this volume if exists.

; created_at - ''string''
: Volume creation timestamp.

=== 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 incorrect credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.
:''HTTP/1.1 404 Not Found'' - The resource does not exist.

=== Examples ===
'''Successfully get single volume details'''
:'''GET''' <nowiki>http://{api_server}/volumes/hbs2012May03_0OxRg0Jz7</nowiki>

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

''Response Body:''
<nowiki>
{
"volume": {
"display_name": "vol-test-003",
"attachments": [],
"links": [
{
"href": "http://{api_server}/volumes/hbs2012May03_0OxRg0Jz7/",
"rel": "self"
}
],
"availability_zone": "test_zone",
"created_at": "2012-05-03 11:35:44",
"volume_type": "",
"display_description": "Another test volume.",
"snapshot_id": "",
"metadata": {},
"id": "hbs2012May03_0OxRg0Jz7",
"size": "30GB"
}
}
</nowiki>

'''Failure while trying to request for a volume that does not exist'''
:'''GET''' http(s)://{api_server}/volumes/{fake_volume_id}

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

''Response Body:''
{
"itemNotFound":
{
"message": "Resource not found",
"code": 404,
"details": ""
}
}

'''Failure while trying to make an unauthorized request'''
:'''GET''' <nowiki>http://{api_server}/volume/{volume_id}</nowiki>

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded fake_authentication_string

''Response Code:''
<pre>HTTP/1.1 401 Unauthorized</pre>

''Response Body:''
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.

[[Category:Hostway API]]
[[Category:FlexCloud Server API]]



{{#widget:DISQUS
|id=hostway
|uniqid={{PAGENAME}}
|url={{fullurl:{{PAGENAME}}}}
}}

Delete Allocated Flexible IP

2013-04-13T01:33:05Z

Administrator: /* DELETE /os-floating-ips/ip_address */

This operation will delete the specified allocated flexible IP address.

=='''DELETE''' /os-floating-ips/'''ip_address'''==

=== Parameters ===
; ip_address - ''string''

=== Response Codes ===
; Success:
:''HTTP/1.1 202 Accepted''
; Failure:
:''HTTP/1.1 401 Unauthorized'' - This server could not verify that you are authorized to access the document you requested. Either you supplied incorrect credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.
:''HTTP/1.1 404 Not Found'' - The resource does not exist.

=== Examples ===

'''Delete the specified allocated flexible IP address'''
:'''DELETE''' http(s)://{api_server}/os-floating-ips/{ip_address}

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''Response Code:''
<pre>HTTP/1.1 202 Accepted</pre>

'''Failure while trying to delete a non-existent allocated floating IP address'''
:'''DELETE''' http(s)://{api_server}/os-floating-ips/{fake_ip_address}

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

'''Unauthorized access'''
:'''DELETE''' http(s)://{api_server}/os-floating-ips/{ip_address}

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded fake_authentication_string

''Response Code:''
<pre>HTTP/1.1 401 Unauthorized</pre>

''Response Body:''
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.

[[Category:Hostway API]]
[[Category:FlexCloud Server API]]



{{#widget:DISQUS
|id=hostway
|uniqid={{PAGENAME}}
|url={{fullurl:{{PAGENAME}}}}
}}

View Allocated Flexible IP

2013-04-13T01:32:29Z

Administrator:

This operation will list details of the specific allocated flexible IP address.

=='''GET''' /os-floating-ips/'''ip_address'''==

=== Parameters ===
; ip_address - ''string''

=== Response ===
==== JSON ====
<nowiki>
{
"floating_ip" : [
{
"instance_id" : {instance_id},
"ip": "{ip_address}",
"fixed_ip": null,
"links": [
{
"href": "http://{api_server}/os-floating-ips/{ip_address}/",
"rel": "self"
}
],
"pool": "default"
}
]
}
</nowiki>

=====floating_ip=====
; instance_id - ''string''
: Unique instance identifier floating IP is assigned to.

; ip - ''string''
: IP address allocated.

; fixed_ip - ''string''
: Fixed IP address.

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

; pool - ''string''
: Name of the pool IP address belongs to.

=== 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 404 Not Found'' - The resource does not exist

=== Examples ===

'''View detailed information for the specified allocated floating IP address'''
:'''GET''' http(s)://{api_server}/os-floating-ips/{ip_address}

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

''Response Body:''
<nowiki>
{
"floating_ip" : [
{
"instance_id": "test_server_0013",
"ip": "{ip_address}",
"fixed_ip": null,
"links": [
{
"href": "http://{api_server}/os-floating-ips/{ip_address}/",
"rel": "self"
}
],
"pool": "default"
}
]
}
</nowiki>

'''Unauthorized access'''
:'''GET''' http(s)://{api_server}/os-floating-ips/{ip_address}

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded fake_authentication_string

''Response Code:''
<pre>HTTP/1.1 401 Unauthorized</pre>

''Response Body:''
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.

'''Failure while trying to view details for a non-existent flexible IP address'''
:'''GET''' http(s)://{api_server}/os-floating-ips/{fake_ip_address}

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

[[Category:Hostway API]]
[[Category:FlexCloud Server API]]



{{#widget:DISQUS
|id=hostway
|uniqid={{PAGENAME}}
|url={{fullurl:{{PAGENAME}}}}
}}

List Flexible IPs

2013-04-13T01:31:26Z

Administrator:

This operation will list all allocated flexible IP addresses in your account.

=='''GET''' /os-floating-ips==

=== Response ===
==== JSON ====
<nowiki>
{
"floating_ips" : [
{
"instance_id" : {instance_id},
"ip": "{ip_address}",
"fixed_ip": null,
"links": [
{
"href": "http://{api_server}/os-floating-ips/{ip_address}/",
"rel": "self"
}
],
"pool": "default"
},
{
"instance_id": "{instance_id}",
"ip": "{ip_address}",
"fixed_ip": null,
"links": [
{
"href": "http://{api_server}/os-floating-ips/{ip_address}/",
"rel": "self"
}
],
"pool": "default"
}
]
}
</nowiki>

=====floating_ips=====
; instance_id - ''string''
: Unique instance identifier floating IP is assigned to.

; ip - ''string''
: IP address allocated.

; fixed_ip - ''string''
: Fixed IP address.

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

; pool - ''string''
: Name of the pool IP address belongs to.

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

=== Examples ===

'''List servers'''
:'''GET''' http(s)://{api_server}/os-floating-ips

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

''Response Body:''
<nowiki>
{
"floating_ips" : [
{
"instance_id" : null,
"ip": "{ip_address}",
"fixed_ip": null,
"links": [
{
"href": "http://{api_server}/os-floating-ips/{ip_address}/",
"rel": "self"
}
],
"pool": "default"
},
{
"instance_id": "test_server_0013",
"ip": "{ip_address}",
"fixed_ip": null,
"links": [
{
"href": "http://{api_server}/os-floating-ips/{ip_address}/",
"rel": "self"
}
],
"pool": "default"
}
]
}
</nowiki>

'''Unauthorized access'''
:'''GET''' <nowiki>http://{api_server}/os-floating-ips</nowiki>

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded fake_authentication_string

''Response Code:''
<pre>HTTP/1.1 401 Unauthorized</pre>

''Response Body:''
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.

[[Category:Hostway API]]
[[Category:FlexCloud Server API]]



{{#widget:DISQUS
|id=hostway
|uniqid={{PAGENAME}}
|url={{fullurl:{{PAGENAME}}}}
}}

Allocate Flexible IP

2013-04-13T01:30:39Z

Administrator: /* POST /os-floating-ips */

A Flexible IP address is a static IP address that can be bound to any single Server. When you associate a flexible IP with a Server the IP is bound to that Server's network interface. You will use your flexible IP to connect to your Server. You can allocate IPs and release IPs from your account as needed.

=='''POST''' /os-floating-ips==
This operation will allocate a new flexible IP.

=== Response ===
==== JSON ====
<nowiki>
{
"floating_ip" : {
"instance_id" : "{instance_id}",
"ip" : "{ip_address}",
"fixed_ip" : null,
"links" : [
{
"href" : "http://{api_server}/os-floating-ips/{ip_address}/",
"rel" : "self"
}
],
"pool" : "default"
}
}
</nowiki>

=====floating_ip=====
; instance_id - ''string''
: Unique instance identifier floating IP is assigned to.

; ip - ''string''
: IP address allocated.

; fixed_ip - ''string''
: Fixed IP address.

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

; pool - ''string''
: Name of the pool IP address belongs to.

=== Response Codes ===
; Success
: ''HTTP/1.1 202 Accepted''

; Failure
: ''HTTP/1.1 401 Unauthorized'' : This server could not verify that you are authorized to access the document you requested. Either you supplied incorrect credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.

=== Examples ===
'''Successfully allocate a flexible IP'''
:'''POST''' http(s)://{api_server}/os-floating-ips

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''Response Code:''
<pre>HTTP/1.1 202 Accepted</pre>

''Response Body:''
<nowiki>
{
"floating_ip" : {
"instance_id" : null,
"ip" : "{ip_address}",
"fixed_ip" : null,
"links" : [
{
"href" : "http://{api_server}/os-floating-ips/{ip_address}/",
"rel" : "self"
}
],
"pool" : "default"
}
}
</nowiki>

'''Unauthorized access'''
:'''POST''' <nowiki>http://{api_server}/os-floating-ips</nowiki>

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded fake_authentication_string

''Response Code:''
<pre>HTTP/1.1 401 Unauthorized</pre>

''Response Body:''
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.

[[Category:Hostway API]]
[[Category:FlexCloud Server API]]



{{#widget:DISQUS
|id=hostway
|uniqid={{PAGENAME}}
|url={{fullurl:{{PAGENAME}}}}
}}

ServerSnapshotCreate

2013-04-13T01:29:17Z

Administrator: /* POST /servers/server_id/snapshots */

This operation will create a new server snapshot of a server. Server snapshot creation is asynchronous, the progress can be checked with the URL in the response Location header or the self link in the body.

='''POST''' /servers/'''server_id'''/snapshots=

== Parameters ==
; server_id
: The unique identifier of the server.

=== JSON ===
<nowiki>
{
"snapshot": {
"name": "{name}",
"description": "{description}"
}
}</nowiki>

; name - ''string''
: Display name for this server snapshot

; description - ''string''
: Description for this server snapshot

== Result ==
=== JSON ===
<nowiki>
{
"snapshot": {
"id": "{snapshot_id}",
"name": "{snapshot_name}"
"description": "{description}",
"status": "{status}",
"guid": "{guid}",
"parent_guid": "{parent_guid}",
"relation_guid": "{relation_guid}",
"create_time": "{create_time}",
"links": [{"href": "http://{api_server}/servers/{server_id}/snapshots/{snapshot_id}/",
"rel": "self"}],
}
}
</nowiki>
* When a server snapshot is in pending status (has not completed the provisioning process), the create_time, guid, parent_guid, and relation_guid will be empty strings.
; id - ''string''
: Unique identifier for this server snapshot.

; name - ''string''
: Display name of this server snapshot.

; description - ''string''
: Description of this server snapshot.

; guid - ''string''
: GUID of this server snapshot.

; parent_guid - ''string''
: Parent GUID of this server snapshot.

; relation_guid - ''string''
: Relation GUID of this server snapshot.

; status - ''string''
: Status of this server snapshot; Values: 'ACTIVE', 'BUILD', 'DELETED'

; create_time - ''string''
: Created time of this server snapshot

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

== Response Codes ==
; Success:
:''HTTP/1.1 202 Accepted''
::Request is accepted.

; Failure:
:''HTTP/1.1 400 Bad Request''
::The snapshot cannot be created because the server contains extra volumes.

:''HTTP/1.1 409 Conflict''
::The snapshot name must be unique in a server.

:''HTTP/1.1 413 Request entity too large''
::The snapshot can be created up to 3 in a server.

== Examples ==
'''Successfully create a new server'''
:'''POST''' <nowiki>http://{api_server}/servers/{server_id}/snapshots</nowiki>

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''Request Body:''
<nowiki>
{
"snapshot": {
"name": "fitnesse snapshot",
"description": "fitnesse test snapshot"
}
}</nowiki>

''Response Code:''
<pre>HTTP/1.1 202 Accepted</pre>

''Response Body:''
<nowiki>
{
"snapshot": {
"id": "snapshot_jello614636-USOTE-0214_2012Jul19_m5yf9Bz8a",
"name": "test snapshot"
"description": "test snapshot description",
"status": "BUILD",
"guid": "",
"parent_guid": "",
"relation_guid": "",
"create_time": "0000-00-00 00:00:00",
"links": [
{"href": "http://{api_server}/servers/{server_id}/snapshots/snapshot_jello614636-USOTE-0214_2012Jul19_m5yf9Bz8a/",
"rel": "self"}],
}
}</nowiki>



{{#widget:DISQUS
|id=hostway
|uniqid={{PAGENAME}}
|url={{fullurl:{{PAGENAME}}}}
}}

ServerSnapshot

2013-04-13T01:27:18Z

Administrator: /* GET /servers/server_id/snapshots/snapshot_id */

This article describes operations for getting details of a server snapshot.
Other types of operations on a server snapshot are: [[ServerSnapshotCreate]], [[ServerSnapshotActions]], etc.

='''GET''' /servers/'''server_id'''/snapshots/'''snapshot_id'''=
This operation will return snapshot details of a single server.

== Parameters ==
; server_id
: The unique identifier of the server.

; snapshot_id
: The unique identifier of the server snapshot to get

== Result ==
=== JSON ===
<nowiki>
{
"snapshot": {
"id": "{snapshot_id}",
"name": "{snapshot_name}"
"description": "{description}",
"status": "{status}",
"guid": "{guid}",
"parent_guid": "{parent_guid}",
"relation_guid": "{relation_guid}",
"create_time": "{create_time}",
"links": [{"href": "http://{api_server}/servers/{server_id}/snapshots/{snapshot_id}/",
"rel": "self"}],
}
}</nowiki>

; id - ''string''
: Unique identifier for this server snapshot.

; name - ''string''
: Display name of this server snapshot.

; description - ''string''
: Description of this server snapshot.

; guid - ''string''
: GUID of this server snapshot.

; parent_guid - ''string''
: Parent GUID of this server snapshot.

; relation_guid - ''string''
: Relation GUID of this server snapshot.

; status - ''string''
: Status of this server snapshot; Values: 'ACTIVE', 'BUILD', 'DELETED'

; create_time - ''string''
: Created time of this server snapshot

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

== 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.
-ItemNotFound (404) : The resource requested is not found.

== Examples ==
'''Successfully get server details'''
:'''GET''' http(s)://{api_server}/servers/snapshots/snapshot_jello614636-USOTE-0214_2012Jul19_m5yf9Bz8a

''- Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''- Response:''
''OK (200)'':
<nowiki>
{
"snapshot": {
"id": "snapshot_jello614636-USOTE-0214_2012Jul19_m5yf9Bz8a",
"name": "fitnesse snapshot"}
"description": "fitnesse test snapshot",
"status": "ACTIVE",
"guid": "a4e76fdf-8696-4848-ba81-cfe090e1401d",
"parent_guid": "491aee4b-34bc-45e5-ac47-7ef9fb96c4c4",
"relation_guid": "42130087-f34c-4823-885d-8a908017ed8d",
"create_time": "2012-07-19 16:28:09",
"links": [{"href": "http://{api_server}/servers/jello614636-USOTE-0214/snapshots/snapshot_jello614636-USOTE-0214_2012Jul19_m5yf9Bz8a/", "rel": "self"}],
}</nowiki>

* When a server is in pending status (has not completed the provisioning process), the creation timestamp and hostId that are returned will be empty strings.

'''Failure while trying to get server details without proper authorization'''
''- Response:''
''Unauthorized (401)'':
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.

'''Failure while trying to get server details for a non-existent server id'''
''- Response:''
''ItemNotFound (404)'':
{
"itemNotFound":
{
"message": "Resource not found",
"code": 404,
"details": "",
"errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
}
}

='''DELETE''' /servers/{server_id}/snapshots/'''snapshot_id'''=
This operation will delete a single server snapshot.

== Parameters ==
; snapshot_id - ''string''
: Id of the server snapshot to delete.

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

== Examples ==
'''Successfully delete a specific server'''
:'''DELETE''' http(s)://{api_server}/servers/123/snapshots/567

''Response Code:''
<pre>HTTP/1.1 202 Accepted</pre>

'''Failure while trying to update a non-existent server'''
:'''DELETE''' http(s)://{api_server}/servers/123/snapshots/{fake_server_id}

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



{{#widget:DISQUS
|id=hostway
|uniqid={{PAGENAME}}
|url={{fullurl:{{PAGENAME}}}}
}}

ServerSnapshotList

2013-04-13T01:23:45Z

Administrator:

This operation will return a list of all [[ServerSnapshot|server snapshots]].

='''GET''' /servers/'''server_id'''/snapshots/'''snapshot_id'''/=

== Parameters ==
; server_id
: The unique identifier of the server.

; snapshot_id
: The unique identifier of the server snapshot

== Result ==
=== JSON ===
<nowiki>
{
'snapshots': [
{
"id": "{snapshot_id}",
"name": "{display_name}",
"description": "{description}",
"guid": "{guid}",
"parent_guid": "{parent_guid}",
"relation_guid": "{releation_guid}",
"status": '{status}',
"create_time": "{create_time}",
"links": [{'href': 'http://{api_server}/servers/{server_id}/', 'rel': 'self'}],
},
{
"id": "{snapshot_id}",
"name": "{display_name}",
"description": "{description}",
"guid": "{guid}",
"parent_guid": "{parent_guid}",
"relation_guid": "{releation_guid}",
"status": '{status}',
"create_time": "{create_time}",
"links": [{'href': 'http://{api_server}/servers/{server_id}/', 'rel': 'self'}],
}
]
}
}</nowiki>

; id - ''string''
: Unique identifier for this server snapshot.

; name - ''string''
: Display name of this server snapshot.

; description - ''string''
: Description of this server snapshot.

; guid - ''string''
: GUID of this server snapshot.

; parent_guid - ''string''
: Parent GUID of this server snapshot.

; relation_guid - ''string''
: Relation GUID of this server snapshot.

; status - ''string''
: Status of this server snapshot; one out of 'ACTIVE', 'BUILD', 'DELETED'

; create_time - ''string''
: Created time of this server snapshot

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

== Response Codes ==
; Success:
:''HTTP/1.1 202 ACCEPTED''

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

== Examples ==
'''Successfully list server snapshots'''
:'''GET''' http(s)://{api_server}/servers/{server_id}/snapshots/

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

''Response Body:''
<nowiki>
{
'snapshots': [
{
"id": "snapshot_jello614636-USOTE-0214_2012Jul18_Fkmm7a2ZM",
"name": "fitnesse snapshot
"description": "fitnesse test snapshot",
"status": "ACTIVE",
"guid": "5c51c729-2cbe-4eb8-a116-6fef5a5f5c12",
"parent_guid": "e039d899-4207-4984-a408-7400a3eaf27b",
"relation_guid": "491aee4b-34bc-45e5-ac47-7ef9fb96c4c4",
"create_time": "2012-07-18 15:48:12",
"links": [
{
"href": "http://{api_server}/servers/{server_id}/snapshots/snapshot_jello614636-USOTE-0214_2012Jul18_Fkmm7a2ZM/",
"rel": "self"
}]
},
{
"id": "snapshot_jello614636-USOTE-0214_2012Jul19_Hzxp5LHGz",
"name": "fitnesse snapshot"
"description": "fitnesse test snapshot",
"status": "DELETED",
"guid": "cdc39fc9-cda9-4eae-aeb9-274e5f8d1642",
"parent_guid": "491aee4b-34bc-45e5-ac47-7ef9fb96c4c4",
"relation_guid": "b4833231-b685-415b-9977-42d7424d6646",
"create_time": "2012-07-19 12:36:55",
"links": [
{
"href": "http://10.10.150.59:6543/servers/{server_id}/snapshots/snapshot_jello614636-USOTE-0214_2012Jul19_Hzxp5LHGz/",
"rel": "self"
}],
},
{
"id": "snapshot_jello614636-USOTE-0214_2012Jul19_m5yf9Bz8a",
"name": "fitnesse snapshot"
"description": "fitnesse test snapshot",
"status": "ACTIVE",
"guid": "a4e76fdf-8696-4848-ba81-cfe090e1401d",
"parent_guid": "491aee4b-34bc-45e5-ac47-7ef9fb96c4c4",
"relation_guid": "42130087-f34c-4823-885d-8a908017ed8d",
"create_time": "2012-07-19 16:28:09",
"links": [
{
"href": "http://10.10.150.59:6543/servers/{server_id}/snapshots/snapshot_jello614636-USOTE-0214_2012Jul19_m5yf9Bz8a/",
"rel": "self"
}],
}
]
}</nowiki>

'''Failure while trying to make unauthorized access'''
:'''GET''' <nowiki>http(s)://{api_server}/servers/{server_id}/snapshots/</nowiki>

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded fake_authentication_string

''Response Code:''
<pre>HTTP/1.1 401 Unauthorized</pre>

''Response Body:''
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.



{{#widget:DISQUS
|id=hostway
|uniqid={{PAGENAME}}
|url={{fullurl:{{PAGENAME}}}}
}}

ServerMonitoringDetailsBandwidth

2013-04-13T01:23:16Z

Administrator:

This operation will list Bandwidth monitoring details for a specific [[Server]].

=='''GET''' /servers/'''id'''/monitoring/bandwidth?''scope=monitoringScope''&''startDate=startDate''&''endDate=endDate''&''period=monitoringPeriod''&''method=statisticsMethod'''''==

=== Parameters ===
; id
: The unique identifier of the server.

; scope
: The monitoring scope used. Possible values: '''receive''' and '''transmit'''.

; startDate
: Start date for monitoring details report in format '''yyyy-mm-dd hh:mm:ss'''.

; endDate
: End date for monitoring details report in format '''yyyy-mm-dd hh:mm:ss'''.

; period
: The time period in seconds used for data interval. Possible values: '''3600'''(one hour) or '''86400'''(one day).

; method
: Statistics method used. Possible values: '''avg''','''sum''','''min''' and '''max'''.

=== Result ===
==== JSON ====
[
{
"count": 143,
"date": "2012-05-07 00:00:00",
"values": 344130.30069930002
},
{
"count": 144,
"date": "2012-05-08 00:00:00",
"values": 658.34027777777999
}
]

; count - ''integer''
: The count of bandwidth operations for the period specified.

; date - ''string''
: The date and time stamp for the period specified.

; values - ''float''
: The sample value calculated depending on statistics method used.

=== Response Codes ===
; Success:
:''HTTP/1.1 200 OK''
:The request is accepted for processing.
; 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 404 Not Found'' - The resource does not exist.

=== Examples ===
'''Successfully get Bandwidth usage monitoring data'''
:'''GET''' http(s)://{api_server}/servers/{server_name}/monitoring/bandwidth?scope=usage&startDate=2012-05-07&endDate=2012-05-10&period=86400&method=avg

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

''Response Body:''
[
{
"count": 143,
"date": "2012-05-07 00:00:00",
"values": 344130.30069930002
},
{
"count": 144,
"date": "2012-05-08 00:00:00",
"values": 658.34027777777999
},
{
"count": 144,
"date": "2012-05-09 00:00:00",
"values": 2.1111111111111001
}
]

'''Failure while trying to get Bandwidth usage monitoring data with a bad scope parameter'''
:'''GET''' http(s)://{api_server}/servers/{server_name}/monitoring/bandwidth?scope=fake-scope&startDate=2012-05-07&endDate=2012-05-10&period=86400&method=avg

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

''Response Body:''
{
"badRequest": {
"message": "Bad request",
"code": 400,
"details": "The bandwidth monitoring scope is not supported"
}
}

'''Failure while trying to get Bandwidth usage monitoring data with a bad date parameter'''
:'''GET''' http(s)://{api_server}/servers/{server_name}/monitoring/bandwidth?scope=usage&startDate=fake-date&endDate=2012-05-10&period=86400&method=avg

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

''Response Body:''
{
"badRequest": {
"message": "Bad request",
"code": 400,
"details": {
"startDate": "Invalid date"
}
}
}

'''Failure while trying to get Bandwidth usage monitoring data with a bad period parameter'''
:'''GET''' http(s)://{api_server}/servers/{server_name}/monitoring/bandwidth?scope=usage&startDate=2012-05-07&endDate=2012-05-10&period=fake-period&method=avg

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

''Response Body:''
{
"badRequest": {
"message": "Bad request",
"code": 400,
"details": {
"period": "\"fake-period\" is not a number"
}
}
}

'''Failure while trying to get Bandwidth usage monitoring data with a bad method parameter'''
:'''GET''' http(s)://{api_server}/servers/{server_name}/monitoring/bandwidth?scope=usage&startDate=2012-05-07&endDate=2012-05-10&period=86400&method=fake-method

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

''Response Body:''
{
"badRequest": {
"message": "Bad request",
"code": 400,
"details": "Invalid statistics_method"
}
}

'''Failure while trying to get Bandwidth usage monitoring data with a missing scope parameter'''
:'''GET''' http(s)://{api_server}/servers/{server_name}/monitoring/bandwidth?startDate=2012-05-07&endDate=2012-05-10&period=86400&method=avg

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

''Response Body:''
{
"badRequest": {
"message": "Bad request",
"code": 400,
"details": "The bandwidth monitoring scope is missing"
}
}

'''Failure while trying to get Bandwidth usage monitoring data with a missing date parameter'''
:'''GET''' http(s)://{api_server}/servers/{server_name}/monitoring/bandwidth?scope=usage&endDate=2012-05-10&period=86400&method=avg

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

''Response Body:''
{
"badRequest": {
"message": "Bad request",
"code": 400,
"details": {
"startDate": "Required"
}
}
}

'''Failure while trying to get Bandwidth usage monitoring data with a missing period parameter'''
:'''GET''' http(s)://{api_server}/servers/{server_name}/monitoring/bandwidth?scope=usage&startDate=2012-05-07&endDate=2012-05-10&method=avg

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

''Response Body:''
{
"badRequest": {
"message": "Bad request",
"code": 400,
"details": {
"period": "Required"
}
}
}

'''Failure while trying to get Bandwidth usage monitoring data with a missing method parameter'''
:'''GET''' http(s)://{api_server}/servers/{server_name}/monitoring/bandwidth?scope=usage&startDate=2012-05-07&endDate=2012-05-10&period=86400

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

''Response Body:''
{
"badRequest": {
"message": "Bad request",
"code": 400,
"details": {
"method": "Required"
}
}
}

'''Failure while trying to get Bandwidth usage monitoring data for a non-existent server'''
:'''GET''' http(s)://{api_server}/servers/{fake-server_name}/monitoring/bandwidth?scope=usage&startDate=2012-05-07&endDate=2012-05-10&period=86400&method=avg

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

''Response Body:''
{
"itemNotFound": {
"message": "Resource not found",
"code": 404,
"details": ""
}
}

'''Unauthorized access'''
:'''GET''' http(s)://{api_server}/servers/{server_name}/monitoring/bandwidth?scope=usage&startDate=2012-05-07&endDate=2012-05-10&period=86400&method=avg

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded fake_authentication_string

''Response Code:''
<pre>HTTP/1.1 401 Unauthorized</pre>

''Response Body:''
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.

[[Category:Hostway API]]
[[Category:FlexCloud Server API]]



{{#widget:DISQUS
|id=hostway
|uniqid={{PAGENAME}}
|url={{fullurl:{{PAGENAME}}}}
}}

ServerMonitoringDetailsDisk

2013-04-13T01:22:15Z

Administrator:

This operation will list Disk monitoring details for a specific [[Server]].

=='''GET''' /servers/'''id'''/monitoring/disk?''scope=monitoringScope''&''startDate=startDate''&''endDate=endDate''&''period=monitoringPeriod''&''method=statisticsMethod'''''==

=== Parameters ===
; id
: The unique identifier of the server.

; scope
: The monitoring scope used. Possible values: '''usage''', '''read_count''', '''write_count''', '''read_bytes''' and '''write_bytes'''.

; startDate
: Start date for monitoring details report in format '''yyyy-mm-dd hh:mm:ss'''.

; endDate
: End date for monitoring details report in format '''yyyy-mm-dd hh:mm:ss'''.

; period
: The time period in seconds used for data interval. Possible values: '''3600'''(one hour) or '''86400'''(one day).

; method
: Statistics method used. Possible values: '''avg''','''sum''','''min''' and '''max'''.

=== Result ===
==== JSON ====
[
{
"count": 144,
"date": "2012-05-07 00:00:00",
"values": 3.2083333333333002
},
{
"count": 143,
"date": "2012-05-08 00:00:00",
"values": 6.0
}
]

; count - ''integer''
: The count of disk operations for the period specified.

; date - ''string''
: The date and time stamp for the period specified.

; values - ''float''
: The sample value calculated depending on statistics method used.

=== Response Codes ===
; Success:
:''HTTP/1.1 200 OK''
:The request is accepted for processing.
; 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 404 Not Found'' - The resource does not exist.

=== Examples ===
'''Successfully get Disk usage monitoring data'''
:'''GET''' http(s)://{api_server}/servers/{server_name}/monitoring/disk?scope=usage&startDate=2012-05-07&endDate=2012-05-10&period=86400&method=avg

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

''Response Body:''
[
{
"count": 144,
"date": "2012-05-07 00:00:00",
"values": 3.2083333333333002
},
{
"count": 143,
"date": "2012-05-08 00:00:00",
"values": 6.0
},
{
"count": 144,
"date": "2012-05-09 00:00:00",
"values": 6.0
}
]

'''Failure while trying to get Disk usage monitoring data with a bad scope parameter'''
:'''GET''' http(s)://{api_server}/servers/{server_name}/monitoring/disk?scope=fake-scope&startDate=2012-05-07&endDate=2012-05-10&period=86400&method=avg

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

''Response Body:''
{
"badRequest": {
"message": "Bad request",
"code": 400,
"details": "The disk monitoring scope is not supported"
}
}

'''Failure while trying to get Disk usage monitoring data with a bad date parameter'''
:'''GET''' http(s)://{api_server}/servers/{server_name}/monitoring/disk?scope=usage&startDate=fake-date&endDate=2012-05-10&period=86400&method=avg

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

''Response Body:''
{
"badRequest": {
"message": "Bad request",
"code": 400,
"details": {
"startDate": "Invalid date"
}
}
}

'''Failure while trying to get Disk usage monitoring data with a bad period parameter'''
:'''GET''' http(s)://{api_server}/servers/{server_name}/monitoring/disk?scope=usage&startDate=2012-05-07&endDate=2012-05-10&period=fake-period&method=avg

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

''Response Body:''
{
"badRequest": {
"message": "Bad request",
"code": 400,
"details": {
"period": "\"fake-period\" is not a number"
}
}
}

'''Failure while trying to get Disk usage monitoring data with a bad method parameter'''
:'''GET''' http(s)://{api_server}/servers/{server_name}/monitoring/disk?scope=usage&startDate=2012-05-07&endDate=2012-05-10&period=86400&method=fake-method

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

''Response Body:''
{
"badRequest": {
"message": "Bad request",
"code": 400,
"details": "Invalid statistics_method"
}
}

'''Failure while trying to get Disk usage monitoring data with a missing scope parameter'''
:'''GET''' http(s)://{api_server}/servers/{server_name}/monitoring/disk?startDate=2012-05-07&endDate=2012-05-10&period=86400&method=avg

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

''Response Body:''
{
"badRequest": {
"message": "Bad request",
"code": 400,
"details": "The disk monitoring scope is missing"
}
}

'''Failure while trying to get Disk usage monitoring data with a missing date parameter'''
:'''GET''' http(s)://{api_server}/servers/{server_name}/monitoring/disk?scope=usage&endDate=2012-05-10&period=86400&method=avg

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

''Response Body:''
{
"badRequest": {
"message": "Bad request",
"code": 400,
"details": {
"startDate": "Required"
}
}
}

'''Failure while trying to get Disk usage monitoring data with a missing period parameter'''
:'''GET''' http(s)://{api_server}/servers/{server_name}/monitoring/disk?scope=usage&startDate=2012-05-07&endDate=2012-05-10&method=avg

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

''Response Body:''
{
"badRequest": {
"message": "Bad request",
"code": 400,
"details": {
"period": "Required"
}
}
}

'''Failure while trying to get Disk usage monitoring data with a missing method parameter'''
:'''GET''' http(s)://{api_server}/servers/{server_name}/monitoring/disk?scope=usage&startDate=2012-05-07&endDate=2012-05-10&period=86400

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

''Response Body:''
{
"badRequest": {
"message": "Bad request",
"code": 400,
"details": {
"method": "Required"
}
}
}

'''Failure while trying to get disk usage monitoring data for a non-existent server'''
:'''GET''' http(s)://{api_server}/servers/{fake-server_name}/monitoring/disk?scope=usage&startDate=2012-05-07&endDate=2012-05-10&period=86400&method=avg

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

''Response Body:''
{
"itemNotFound": {
"message": "Resource not found",
"code": 404,
"details": ""
}
}

'''Unauthorized access'''
:'''GET''' http(s)://{api_server}/servers/{server_name}/monitoring/disk?scope=usage&startDate=2012-05-07&endDate=2012-05-10&period=86400&method=avg

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded fake_authentication_string

''Response Code:''
<pre>HTTP/1.1 401 Unauthorized</pre>

''Response Body:''
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.

[[Category:Hostway API]]
[[Category:FlexCloud Server API]]



{{#widget:DISQUS
|id=hostway
|uniqid={{PAGENAME}}
|url={{fullurl:{{PAGENAME}}}}
}}

ServerMonitoringDetailsCPU

2013-04-13T01:21:40Z

Administrator:

This operation will list CPU monitoring details for a specific [[Server]].

=='''GET''' /servers/'''id'''/monitoring/cpu?''startDate=startDate''&''endDate=endDate''&''period=monitoringPeriod''&''method=statisticsMethod'''''==

=== Parameters ===
; id
: The unique identifier of the server.

; startDate
: Start date for monitoring details report in format '''yyyy-mm-dd hh:mm:ss'''.

; endDate
: End date for monitoring details report in format '''yyyy-mm-dd hh:mm:ss'''.

; period
: The time period in seconds used for data interval. Possible values: '''3600'''(one hour) or '''86400'''(one day).

; method
: Statistics method used. Possible values: '''avg''','''sum''','''min''' and '''max'''.

=== Result ===
==== JSON ====
[
{
"count": 144,
"date": "2012-05-07 00:00:00",
"values": 0.0
},
{
"count": 143,
"date": "2012-05-08 00:00:00",
"values": 0.0
}
]

; count - ''integer''
: The count of CPU operations for the period specified.

; date - ''string''
: The date and time stamp for the period specified.

; values - ''float''
: The sample value calculated depending on statistics method used.

=== Response Codes ===
; Success:
:''HTTP/1.1 200 OK''
:The request is accepted for processing.
; 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 404 Not Found'' - The resource does not exist.

=== Examples ===
'''Successfully get CPU usage monitoring data'''
:'''GET''' http(s)://{api_server}/servers/{server_name}/monitoring/cpu?startDate=2012-05-07&endDate=2012-05-10&period=86400&method=avg

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

''Response Body:''
[
{
"count": 144,
"date": "2012-05-07 00:00:00",
"values": 0.0
},
{
"count": 143,
"date": "2012-05-08 00:00:00",
"values": 0.0
},
{
"count": 144,
"date": "2012-05-09 00:00:00",
"values": 0.0
}
]

'''Failure while trying to get CPU usage monitoring data with a bad date parameter'''
:'''GET''' http(s)://{api_server}/servers/{server_name}/monitoring/cpu?startDate=fake-date&endDate=2012-05-10&period=86400&method=avg

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

''Response Body:''
{
"badRequest": {
"message": "Bad request",
"code": 400,
"details": {
"startDate": "Invalid date"
}
}
}

'''Failure while trying to get CPU usage monitoring data with a bad period parameter'''
:'''GET''' http(s)://{api_server}/servers/{server_name}/monitoring/cpu?startDate=2012-05-07&endDate=2012-05-10&period=fake-period&method=avg

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

''Response Body:''
{
"badRequest": {
"message": "Bad request",
"code": 400,
"details": {
"period": "\"fake-period\" is not a number"
}
}
}

'''Failure while trying to get CPU usage monitoring data with a bad method parameter'''
:'''GET''' http(s)://{api_server}/servers/{server_name}/monitoring/cpu?startDate=2012-05-07&endDate=2012-05-10&period=86400&method=fake-method

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

''Response Body:''
{
"badRequest": {
"message": "Bad request",
"code": 400,
"details": "Invalid statistics_method"
}
}

'''Failure while trying to get CPU usage monitoring data with a missing date parameter'''
:'''GET''' http(s)://{api_server}/servers/{server_name}/monitoring/cpu?endDate=2012-05-10&period=86400&method=avg

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

''Response Body:''
{
"badRequest": {
"message": "Bad request",
"code": 400,
"details": {
"startDate": "Required"
}
}
}

'''Failure while trying to get CPU usage monitoring data with a missing period parameter'''
:'''GET''' http(s)://{api_server}/servers/{server_name}/monitoring/cpu?startDate=2012-05-07&endDate=2012-05-10&method=avg

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

''Response Body:''
{
"badRequest": {
"message": "Bad request",
"code": 400,
"details": {
"period": "Required"
}
}
}

'''Failure while trying to get CPU usage monitoring data with a missing method parameter'''
:'''GET''' http(s)://{api_server}/servers/{server_name}/monitoring/cpu?startDate=2012-05-07&endDate=2012-05-10&period=86400

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

''Response Body:''
{
"badRequest": {
"message": "Bad request",
"code": 400,
"details": {
"method": "Required"
}
}
}

'''Failure while trying to get CPU usage monitoring data for a non-existent server'''
:'''GET''' http(s)://{api_server}/servers/{fake-server_name}/monitoring/cpu?startDate=2012-05-07&endDate=2012-05-10&period=86400&method=avg

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

''Response Body:''
{
"itemNotFound": {
"message": "Resource not found",
"code": 404,
"details": ""
}
}

'''Unauthorized access'''
:'''GET''' http(s)://{api_server}/servers/{server_name}/monitoring/cpu?startDate=2012-05-07&endDate=2012-05-10&period=86400&method=avg

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded fake_authentication_string

''Response Code:''
<pre>HTTP/1.1 401 Unauthorized</pre>

''Response Body:''
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.

[[Category:Hostway API]]
[[Category:FlexCloud Server API]]



{{#widget:DISQUS
|id=hostway
|uniqid={{PAGENAME}}
|url={{fullurl:{{PAGENAME}}}}
}}

DetachVolumeFromServer

2013-04-13T01:20:56Z

Administrator:

This operation will detach a volume attachment from the server specified.

=='''DELETE''' /servers/'''server_id'''/os-volume_attachments/'''volume_id'''''==

=== Parameters ===
; server_id
: The unique identifier of the server.

; volume_id
: The unique volume identifier.

=== Response Codes ===
; Success:
:''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 incorrect credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.
:''HTTP/1.1 404 Not Found'' - The resource does not exist.

=== Examples ===
'''Successfully detach a server's volume attachment'''
:'''DELETE''' http(s)://{api_server}/servers/test-server-0013/os-volume_attachments/hbs2012May03_0OxRg0Jz7

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

'''Failure while trying to detach a volume attachment that does not exist'''
:'''GET''' http(s)://{api_server}/servers/test-server-0013/os-volume_attachments/fake_volume_id

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

''Response Body:''
{
"itemNotFound":
{
"message": "Resource not found",
"code": 404,
"details": ""
}
}

'''Failure while trying to detach a volume attachment for a server that does not exist'''
:'''DELETE''' http(s)://{api_server}/servers/fake_server_id/os-volume_attachments/hbs2012May03_0OxRg0Jz7

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

''Response Body:''
{
"itemNotFound":
{
"message": "Resource not found",
"code": 404,
"details": ""
}
}

'''Unauthorized request'''
:'''DELETE''' http(s)://{api_server}/servers/test-server-0013/os-volume_attachments/hbs2012May03_0OxRg0Jz7

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded fake_authentication_string

''Response Code:''
<pre>HTTP/1.1 401 Unauthorized</pre>

''Response Body:''
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.

[[Category:Hostway API]]
[[Category:FlexCloud Server API]]



{{#widget:DISQUS
|id=hostway
|uniqid={{PAGENAME}}
|url={{fullurl:{{PAGENAME}}}}
}}

ListVolumeDetailsForServerVolumeAttachment

2013-04-13T01:19:50Z

Administrator:

This operation will return the volume details for the specific server's volume attachment.

=='''GET''' /servers/'''server_id'''/os-volume_attachments/'''volume_id'''''==

=== Parameters ===
; server_id
: The unique identifier of the server.

; volume_id
: The unique volume identifier.

=== Result ===
==== JSON ====
<nowiki>
{
"volume" : {
"id": "{volume_id}",
"display_name" : "{display_volume_name}",
"display_description" : "{display_volume_description}",
"size" : {size_quantity},
"volume_type" : "{volume_type_id}",
"metadata" : {},
"availability_zone" : "{availability_zone_id}",
"attachments": [],
"links": [
{
"href": "http://{api_server}/volumes/{volume_id}/",
"rel": "self"
}
],
"snapshot_id": "",
"created_at": "2012-05-03 11:35:44"
}
}
</nowiki>

=====volume=====
; id - ''string''
: Identifier of the volume instance.

; display_name - ''string''
: Display name for this volume.

; display_description - ''string''
: Descriptive information for this volume.

; size - ''int''
: Volume size.

; volume_type - ''string''
: Identifier of the volume type used. *(Not used in the current version).

; metadata - ''string''
: Additional metadata info.

; availability_zone - ''string''
: Identifier of the availability zone into which this volume was created.

; attachments - ''list''
: List of attachments this volume is associated with.

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

; snapshot_id - ''string''
: Identifier of the snapshot associated with this volume if exists.

; created_at - ''string''
: Volume creation timestamp.

=== 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 incorrect credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.
:''HTTP/1.1 404 Not Found'' - The resource does not exist.

=== Examples ===
'''Successfully get volume details for a server volume attachment'''
:'''GET''' http(s)://{api_server}/servers/test-server-0013/os-volume_attachments/hbs2012May03_0OxRg0Jz7

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

''Response Body:''
<nowiki>
{
"volume": {
"display_name": "vol-test-003",
"attachments": [],
"links": [
{
"href": "http://{api_server}/volumes/hbs2012May03_0OxRg0Jz7/",
"rel": "self"
}
],
"availability_zone": "test_zone",
"created_at": "2012-05-03 11:35:44",
"volume_type": "",
"display_description": "Another test volume.",
"snapshot_id": "",
"metadata": {},
"id": "hbs2012May03_0OxRg0Jz7",
"size": "30GB"
}
}
</nowiki>

'''Failure while trying to get volume details for a volume that does not exist'''
:'''GET''' http(s)://{api_server}/servers/test-server-0013/os-volume_attachments/fake_volume_id

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

''Response Body:''
{
"itemNotFound":
{
"message": "Resource not found",
"code": 404,
"details": ""
}
}

'''Failure while trying to get volume details for a server that does not exist'''
:'''GET''' http(s)://{api_server}/servers/fake_server_id/os-volume_attachments/hbs2012May03_0OxRg0Jz7

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

''Response Body:''
{
"itemNotFound":
{
"message": "Resource not found",
"code": 404,
"details": ""
}
}
'''Unauthorized request'''
:'''GET''' http(s)://{api_server}/servers/test-server-0013/os-volume_attachments/hbs2012May03_0OxRg0Jz7

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded fake_authentication_string

''Response Code:''
<pre>HTTP/1.1 401 Unauthorized</pre>

''Response Body:''
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.

[[Category:Hostway API]]
[[Category:FlexCloud Server API]]



{{#widget:DISQUS
|id=hostway
|uniqid={{PAGENAME}}
|url={{fullurl:{{PAGENAME}}}}
}}

ListVolumeAttachmentsForServer

2013-04-13T01:18:09Z

Administrator:

This operation will list all of the volume attachments for a specific [[Server]].

=='''GET''' /servers/'''id'''/os-volume_attachments''==

=== Parameters ===
; id
: The unique identifier of the server.

=== Result ===
==== JSON ====
<nowiki>
{
"volumeAttachments": [
{
"device": "{device_path}",
"serverId": {server_id},
"id": {volume_attachment_id},
"volumeId": {volume_id}
},
{
"device": "{device_path}",
"serverId": {server_id},
"id": {volume_attachment_id},
"volumeId": {volume_id}
}
]
}</nowiki>

=====volumeAttachments=====
; device - ''string''
: Device used for this volume attachment.

; serverId - ''string''
: Unique server identifier.

; id - ''string''
: Unique volume attachment identifier.

; volumeId - ''string''
: Unique volume identifier.

=== 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 incorrect credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.
:''HTTP/1.1 404 Not Found''

=== Examples ===
'''Successfully list volume attachments'''
:'''GET''' http(s)://{api_server}/servers/{server_id}/os-volume_attachments

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

''Response Body:''
<nowiki>
{
"volumeAttachments": [
{
"device": "/dev/test",
"serverId": 6,
"id": 1,
"volumeId": 41
},
{
"device": "/dev/test1",
"serverId": 6,
"id": 2,
"volumeId": 23
}
]
}</nowiki>

'''Failure while trying to list volume attachments for a non-existent server'''
:'''GET''' http(s)://{api_server}/servers/{fake_server_id}/os-volume_attachments

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

''Response Body:''
{
"itemNotFound" : {
"message": "Resource not found",
"code": 404,
"details": ""
}
}

'''Unauthorized request'''
:'''GET''' http(s)://{api_server}/servers/{server_id}/os-volume_attachments

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded fake_authentication_string

''Response Code:''
<pre>HTTP/1.1 401 Unauthorized</pre>

''Response Body:''
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.

[[Category:Hostway API]]
[[Category:FlexCloud Server API]]



{{#widget:DISQUS
|id=hostway
|uniqid={{PAGENAME}}
|url={{fullurl:{{PAGENAME}}}}
}}

AttachVolumeToServer

2013-04-13T01:17:42Z

Administrator:

This operation will attach an already existing volume to the specified [[Server]].

=='''POST''' /servers/'''id'''/os-volume_attachments==

=== Parameters ===
; id
: The unique identifier of the server.

=== Request===
==== JSON ====
{
"volumeAttachment" : {
"volumeId" : "{volume_id}",
"device": "{device_path}"
}
}

; volumeId- ''string''
: The unique identifier of the volume.

; device- ''string''
: The device path specified.

=== 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 incorrect credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.
: ''HTTP/1.1 404 Not Found''
: ''HTTP/1.1 409 Conflict''

=== Examples ===
'''Successfully attach a volume to specified server'''
:'''POST''' http(s)://{api_server}/servers/test_server_0013/os-volume_attachments

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''Request Body:''
{
"volumeAttachment" : {
"volumeId" : "hbs2012May08_61EfdIZ3Y",
"device": "/dev/test"
}
}

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

'''Failure while trying to attach a volume that is already attached to the server'''
:'''POST''' http(s)://{api_server}/servers/test_server_0013/os-volume_attachments

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''Request Body:''
{
"volumeAttachment" : {
"volumeId" : "hbs2012May08_61EfdIZ3Y",
"device": "/dev/test"
}
}

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

''Response Body:''
<nowiki>
{
"conflict": {
"message": "VolumeAlreadyAttached",
"code": 409,
"details": "hbs is already attached"
}
}</nowiki>

'''Failure while trying to attach a volume that does not exist'''
:'''POST''' http(s)://{api_server}/servers/test_server_0013/os-volume_attachments

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''Request Body:''
{
"volumeAttachment" : {
"volumeId" : "fake_volume_id",
"device": "/dev/test"
}
}

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

''Response Body:''
<nowiki>
{
"notFound": {
"message": "VolumeNotFound",
"code": 404,
"details": "hostway block store not found"}
}
}</nowiki>

'''Unauthorized access'''
:'''POST''' http(s)://{api_server}/servers/test_server_0013/os-volume_attachments

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded fake_authentication_string

''Response Code:''
<pre>HTTP/1.1 401 Unauthorized</pre>

''Response Body:''
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.

[[Category:Hostway API]]
[[Category:FlexCloud Server API]]



{{#widget:DISQUS
|id=hostway
|uniqid={{PAGENAME}}
|url={{fullurl:{{PAGENAME}}}}
}}

ListServerIPs

2013-04-13T01:16:59Z

Administrator:

This operation will list all flexible IPs assigned to a specific [[Server]].

=='''GET''' /servers/'''id'''/ips''==

=== Parameters ===
; id
: The unique identifier of the server.

=== Result ===
==== JSON ====
<nowiki>
{
"addresses" : {
"public" : [
{
"version" : 4,
"addr" : "{ip_address}"
}
],
"private" : [
{
"version" : 4,
"addr" : "{ip_address}"
}
]
},
"links" : [
{
"href" : "http://{api_server}/servers/{server_id}/ips",
"rel": "self"
}
]
}
</nowiki>

; addr - ''string''
: The address of the allocated flexible IP.

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

=== 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 incorrect credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.
:''HTTP/1.1 404 Not Found'' - Resource not found.

=== Examples ===

'''Successfully list all flexible IPs assigned to the specified server'''
:'''GET''' http(s)://{api_server}/servers/test_server_0013/ips

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

''Response Body:''
<nowiki>
{
"addresses" : {
"public" : [
{
"version" : 4,
"addr" : "{ip_address}"
}
],
"private" : [
{
"version" : 4,
"addr" : "{ip_address}"
}
]
},
"links" : [
{
"href" : "http://{api_server}/servers/test_server_0013/ips",
"rel": "self"
}
]
}
</nowiki>

'''Unauthorized access'''
:'''GET''' http(s)://{api_server}/servers/test_server_0013/ips

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded fake_authentication_string

''Response Code:''
<pre>HTTP/1.1 401 Unauthorized</pre>

''Response Body:''
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.

'''Failure while trying to list flexible IPs for a non-existent server'''
:'''GET''' http(s)://{api_server}/servers/{fake_server_id}/ips

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

''Response Body:''
{
"itemNotFound" : {
"message": "Resource not found",
"code": 404,
"details": ""
}
}

[[Category:Hostway API]]
[[Category:FlexCloud Server API]]



{{#widget:DISQUS
|id=hostway
|uniqid={{PAGENAME}}
|url={{fullurl:{{PAGENAME}}}}
}}

ServerActionUpgradePlesk

2013-04-13T01:16:08Z

Administrator:

This operation will upgrade the Plesk license for the specified [[Server]].

=='''POST''' /servers/'''id'''/action==

=== Parameters ===
; id
: The unique identifier of the server.

=== Request===
==== JSON ====
<nowiki>
{
"upgradePlesk" : {
"username": "{plesk_server_username}",
"password": "{plesk_server_password}",
"port_number": "{plesk_server_port}",
"addon_textkey": "{plesk_addon_textkey}"
}
}</nowiki>

=====upgradePlesk=====
; username - ''string''
: The username used for authentication for managing Plesk license.

; password - ''string''
: The password used for authentication for managing Plesk license.

; port_number - ''string''
: The port used for managing Plesk license.

; addon_textkey - ''string''
: Plesk addon textkey to upgrade to.

=== Response Codes ===
; Success:
: ''HTTP/1.1 202 Accepted'' : The request is accepted for processing.

; Failure:
: ''HTTP/1.1 400 Bad Request'' : Check your parameter / Server not found
: ''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'' : The server understood the request, but is refusing to fulfill it.
: ''HTTP/1.1 404 Not Found'' : The resource does not exist.
: ''HTTP/1.1 409 Conflict'' : The request could not be completed due to a conflict with the current state of the resource. / Wrong Addon TextKey

=== Examples ===
'''Successfully upgrade Plesk server license'''
:'''POST''' http(s)://{api_server}/servers/test_server_0013/action

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''Request Body:''
{
"upgradePlesk" : {
"username": "plesk-username",
"password": "plesk-password",
"port_number": "12",
"addon_textkey": "plesk.9.linux.powerpack"
}
}

''Response Code:''
<pre>HTTP/1.1 202 Accepted</pre>

'''Failure while trying to upgrade Plesk while server is processing another task'''
:'''POST''' http(s)://{api_server}/servers/test_server_0013/action

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''Request Body:''
{
"upgradePlesk" : {
"username": "plesk-username",
"password": "plesk-password",
"port_number": "12",
"addon_textkey": "plesk.9.linux.powerpack"
}
}

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

''Response Body:''
{
"conflict": {
"message": "PleskStillUpgrading",
"code": 409,
"details": "Some task is in processing for this instance. please wait for a while"
}
}

'''Unauthorized access'''
:'''POST''' http(s)://{api_server}/servers/test_server_0013/action

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded fake_authentication_string

''Request Body:''
{
"upgradePlesk" : {
"username": "plesk-username",
"password": "plesk-password",
"port_number": "12",
"addon_textkey": "plesk.9.linux.powerpack"
}
}

''Response Code:''
<pre>HTTP/1.1 401 Unauthorized</pre>

''Response Body:''
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.

'''Failure while trying to upgrade Plesk with an empty parameter body'''
:'''POST''' http(s)://{api_server}/servers/test_server_0013/action

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''Request Body:''
{
empty
}

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

''Response Body:''
{
"badRequest": {
"message": "Bad Request",
"code": 400,
"details": "Multiple actions per request are not allowed"
}
}

'''Failure while trying to upgrade Plesk with incorrect Plesk server credentials'''
:'''POST''' http(s)://{api_server}/servers/test_server_0013/action

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''Request Body:''
{
"upgradePlesk" : {
"username": "fake-plesk-username",
"password": "fake-plesk-password",
"port_number": "12",
"addon_textkey": "plesk.9.linux.powerpack"
}
}

''Response Code:''
<pre>HTTP/1.1 403 Forbidden</pre>

''Response Body:''
{
"forbidden": {
"message": "WrongPleskAuthentication",
"code": 403,
"details": "Could not login to Plesk vm, check your VM login information"
}
}

'''Failure while trying to upgrade Plesk for a non-existent port server'''
:'''POST''' http(s)://{api_server}/servers/test_server_0013/action

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''Request Body:''
{
"upgradePlesk" : {
"username": "plesk-username",
"password": "plesk-password",
"port_number": "1222",
"addon_textkey": "plesk.9.linux.powerpack"
}
}

''Response Code:''
<pre>HTTP/1.1 403 Forbidden</pre>

''Response Body:''
{
"forbidden": {
"message": "WrongPleskAuthentication",
"code": 403,
"details": "Could not login to Plesk vm, check your VM login information"
}
}

'''Failure while trying to upgrade Plesk for a non-existent Plesk addon textkey'''
:'''POST''' http(s)://{api_server}/servers/test_server_0013/action

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''Request Body:''
{
"upgradePlesk" : {
"username": "plesk-username",
"password": "plesk-password",
"port_number": "12",
"addon_textkey": "fake.plesk.addon.textkey"
}
}

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

''Response Body:''
{
"conflict": {
"message": "WrongAddonTextkey",
"code": 409,
"details": "Please specify proper addon textkey"
}
}

'''Failure while trying to upgrade Plesk for a non-existent Plesk server'''
:'''POST''' http(s)://{api_server}/servers/fake_server_name/action

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''Request Body:''
{
"upgradePlesk" : {
"username": "plesk-username",
"password": "plesk-password",
"port_number": "12",
"addon_textkey": "plesk.9.linux.powerpack"
}
}

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

''Response Body:''
{
"itemNotFound": {
"message": "Resource not found",
"code": 404,
"details": ""
}
}

[[Category:Hostway API]]
[[Category:FlexCloud Server API]]



{{#widget:DISQUS
|id=hostway
|uniqid={{PAGENAME}}
|url={{fullurl:{{PAGENAME}}}}
}}

ServerActionRemoveFlexibleIP

2013-04-13T01:15:33Z

Administrator:

This operation will remove an already assigned flexible IP from a [[Server]].

=='''POST''' /servers/'''id'''/action==

=== Parameters ===
; id
: The unique identifier of the server.

=== Request===
==== JSON ====
{
"removeFloatingIp" :
{
"address" : {ip_address}
}
}

; address - ''string''
: The address of the allocated flexible IP.

=== Response Codes ===
; Success:
: ''HTTP/1.1 202 Accepted'' : The request is accepted for processing.

; Failure:
: ''HTTP/1.1 400 Bad Request'' : Check your parameter (no address in JSON). / Server Not Found.
: ''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 409 Conflict'' : Server not provisioned. / Invalid IP address
: ''HTTP/1.1 502 Bad Gateway'' : Error while removing IP address ...

[[Category:Hostway API]]
[[Category:FlexCloud Server API]]



{{#widget:DISQUS
|id=hostway
|uniqid={{PAGENAME}}
|url={{fullurl:{{PAGENAME}}}}
}}

ServerActionAddFlexibleIP

2013-04-13T01:13:18Z

Administrator:

This operation will assign an already allocated flexible IP to the specified [[server]].

=='''POST''' /servers/'''id'''/action==

=== Parameters ===
; id
: The unique identifier of the server.

=== Request===
==== JSON ====
{
"addFloatingIp" :
{
"address" : {ip_address}
}
}

; address - ''string''
: The address of the allocated floating IP.

=== Response Codes ===
; Success:
: ''HTTP/1.1 202 Accepted'' : The request is accepted for processing.

; Failure:
: ''HTTP/1.1 400 Bad Request'' : Check your parameter (no address in JSON). / Server Not Found.
: ''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'' : The server understood the request, but is refusing to fulfill it. The IP address specified is already assigned to another resource instance.
: ''HTTP/1.1 409 Conflict'' : Server not provisioned.
: ''HTTP/1.1 502 Bad Gateway'' : Error while assigning IP address ... / Invalid data received when assigning IP address ...

[[Category:Hostway API]]
[[Category:FlexCloud Server API]]



{{#widget:DISQUS
|id=hostway
|uniqid={{PAGENAME}}
|url={{fullurl:{{PAGENAME}}}}
}}

ServerActionResize

2013-04-13T01:12:40Z

Administrator:

The resize action changes the [[Flavor]] of a [[Server]].

=='''POST''' /servers/'''id'''/action==

=== Parameters ===
; id
: The unique identifier of the server to be resized.

=== Request===
==== JSON ====
{
"resize" :
{
"flavor":
{
"id":"{flavor_id}"
}
}
}

; id - ''string''
: The id of the flavor to use.

=== Response Codes ===
; Success:
: ''HTTP/1.1 202 Accepted'' : The request is accepted for processing.

; Failure:
: ''HTTP/1.1 400 Bad Request'' : Server already uses this flavor.
: ''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'' : This server cannot be resized.
: ''HTTP/1.1 405 Method Not Allowed'' : The requested action is not supported.
: ''HTTP/1.1 500 Internal Server Error'' : Unknown error was raised while processing your request.
: ''HTTP/1.1 503 Service Unavailable'' : Selected profile is unavailable.

[[Category:Hostway API]]
[[Category:FlexCloud Server API]]



{{#widget:DISQUS
|id=hostway
|uniqid={{PAGENAME}}
|url={{fullurl:{{PAGENAME}}}}
}}

ServerActionStart

2013-04-13T01:12:01Z

Administrator:

The start action is used for starting a [[Server]]. Starting a stopped server will change its status from STOPPED to ACTIVE.

=='''POST''' /servers/'''id'''/action==

=== Parameters ===
; id
: The unique identifier of the server to reboot.

==== JSON ====
<nowiki>
{
"os-start": null
}</nowiki>

=== Response Codes ===
; Success:
:''HTTP/1.1 202 Accepted'' : The request is accepted for processing.

; Failure:
: ''HTTP/1.1 400 Bad Request'' : An error occurred.
:''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 404 Not Found'' : The resource requested is not found.
: ''HTTP/1.1 405 Method Not Allowed'' : The requested action is not supported.
: ''HTTP/1.1 409 Conflict'' : Other status change in progress.

[[Category:Hostway API]]
[[Category:FlexCloud Server API]]



{{#widget:DISQUS
|id=hostway
|uniqid={{PAGENAME}}
|url={{fullurl:{{PAGENAME}}}}
}}

ServerActionStop

2013-04-13T01:11:32Z

Administrator:

The stop action is used for stopping a [[Server]]. Stopping a server changes its status from ACTIVE to STOPPED.

=='''POST''' /servers/'''id'''/action==

=== Parameters ===
; id
: The unique identifier of the server to reboot.

==== JSON ====
<nowiki>
{
"os-stop": null
}</nowiki>

=== Response Codes ===
; Success:
:''HTTP/1.1 202 Accepted'' : The request is accepted for processing.

; Failure:
: ''HTTP/1.1 400 Bad Request'' : An error occurred.
:''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 404 Not Found'' : The resource requested is not found.
: ''HTTP/1.1 405 Method Not Allowed'' : The requested action is not supported.
: ''HTTP/1.1 409 Conflict'' : Other status change in progress.

[[Category:Hostway API]]
[[Category:FlexCloud Server API]]



{{#widget:DISQUS
|id=hostway
|uniqid={{PAGENAME}}
|url={{fullurl:{{PAGENAME}}}}
}}

ServerActionReboot

2013-04-13T01:11:05Z

Administrator:

The reboot action allows for either a soft or hard reboot of a [[Server]]. With a soft reboot (SOFT), the operating system is signaled to restart, which allows for a graceful shutdown of all processes. A hard reboot (HARD) is the equivalent of power cycling the server.

=='''POST''' /servers/'''id'''/action==

=== Parameters ===
; id
: The unique identifier of the server to reboot.

==== JSON ====
<nowiki>
{
"reboot":
{
"type": "HARD"
}
}</nowiki>

; type - ''string''
: Type of reboot to perform. Values: '''HARD''', '''SOFT'''.

=== Response Codes ===
; Success:
: ''HTTP/1.1 202 Accepted'' : The request is accepted for processing.

; Failure:
: ''HTTP/1.1 400 Bad Request'' : Check your parameter. / Other error
: ''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 404 Not Found'' : The resource requested is not found.
: ''HTTP/1.1 405 Method Not Allowed'' : The requested action is not supported.
: ''HTTP/1.1 409 Conflict'' : Already rebooting.

[[Category:Hostway API]]
[[Category:FlexCloud Server API]]



{{#widget:DISQUS
|id=hostway
|uniqid={{PAGENAME}}
|url={{fullurl:{{PAGENAME}}}}
}}

ServerCreate

2013-04-13T01:07:44Z

Administrator:

This operation will create a new server. Server creation is asynchronous, the progress can be checked with the URL in the response Location header or the self link in the body.

=='''POST''' /servers==

=== Parameters ===
==== JSON ====
<nowiki>
{
"server":{
"name":"{display_server_name}",
"imageRef":"http://{server_name}/images/{image_id}/",
"flavorRef":"http://{server_name}/flavors/{flavor_id}/",
"adminPass":"{initial_password}"
}
}
</nowiki>

; name - ''string''
: Display name for this server

; imageRef - ''string''
: Absolute URL of the [[Image]] to use

; flavorRef - ''string''
: Absolute URL of the [[Flavor]] to use

; adminPass - ''string''
: Initial admin password. If not specified, the automatically generated password would be returned.

=== Result ===
==== JSON ====
<nowiki>
{
"server":{
"status":"{state_status}",
"updated":null,
"hostId":"",
"addresses":{
"public":[
{
"version":4,
"addr":"{ip_address}"
}
],
"private":[
{
"version":4,
"addr":"{ip_address}"
}
]
},
"links":[
{
"href":"http://{server_name}/servers/{server_id}/",
"rel":"self"
}
],
"image":{
"name":"{display_image_name}",
"links":[
{
"href":"http://{server_name}/images/{image_id}/",
"rel":"self"
}
],
"id":"{image_id}"
},
"userId":"{user_account_id}",
"flavor":{
"name":"{display_flavor_name}",
"links":[
{
"href":"{server_name}/flavors/{flavor_id}/",
"rel":"self"
}
],
"id":{flavor_id}
},
"id":"{server_id}",
"name":"{display_server_name}",
"adminPass": "{initial_password}"
"created":"",
"tenantId":null,
"accessIPv4":"{ip_address}",
"accessIPv6":null,
"progress":0,
"metadata":{
},
}
}
</nowiki>
* When a server is in pending status (has not completed the provisioning process), the creation timestamp and hostId that are returned will be empty strings.
===== server =====
; id - ''string''
: Unique identifier for this server.

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

; status - ''string''
: Current state of the server. Values: '''BUILD''', '''ACTIVE''', '''SUSPENDED''', '''DELETED''', '''UNKNOWN'''

; hostId - ''string''
: Id of the physical host this virtual machine is running on.

; userId - ''string''
: Unique identifier for the owner of this server.

; name - ''string''
: Display name for this server.

; created - ''string''
: The date and time this server was created. ISO 8601 format, YYYY-MM-DDTHH:MM:SS.

; accessIPv4 - ''string''
: The default included public IPv4 address.

; progress - ''number''
: The progress of the current this server while in the BUILD status. The value is in the range of 0 - 100, but currently will only even be 0, 50, 100.

; adminPass - ''string''
: The admin password. Not null only in the creating server response.

; metadata - ''object''
: Unused always an empty object.

; tenantId
: Unused always always null.

; accessIPv6
: Unused always null.

; updated
: Unused always null.

===== addresses =====
; addresses.public.version - ''number''
: IP version of this address. Values: '''4'''

; addresses.public.addr = ''string''
: Public IP address of this server

; addresses.private.version - ''number''
: IP version of this address. Values: '''4'''

; addresses.private.addr - ''string''
: Private IP address of this server

===== image =====
; image.name - ''string''
: The display name of the image this server is based on.

; image.links - ''list''
: [[Hypermedia]] for the image.

; image.id - ''string''
: Unique identifier for image this server is based on.

===== flavor =====
; flavor.name - ''string''
: The display name of the flavor this server is based on.

; flavor.links - ''list''
: [[Hypermedia]] for the flavor.

; flavor.id - ''string''
: Unique identifier for flavor this server is based on.

=== Response Codes ===
; Success:
:''HTTP/1.1 202 Accepted''
::Request is accepted.

; Failure:
:''HTTP/1.1 400 Bad Request''
::The resource used for creating server is not found.

=== Examples ===
'''Successfully create a new server'''
:'''POST''' <nowiki>http://{api_server}/servers</nowiki>

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''Request Body:''
<nowiki>
{
"server" :
{
"flavorRef" : "http://{api_server}//flavors/1",
"name" : "test_server_create",
"imageRef" : "http://{api_server}//images/test_public_image"
}
}
</nowiki>
''Response Code:''
<pre>HTTP/1.1 202 Accepted</pre>

''Response Body:''
<nowiki>
{
"server":
{
"status": "BUILD",
"updated": null,
"hostId": "",
"addresses":
{
"public": [
{
"version": 4,
"addr": "{ip_address}"
}
],
"private": [
{
"version": 4,
"addr": "{ip_address}"
}
]
},
"links": [
{
"href": "http://{api_server}/servers/167/",
"rel": "self"
}
],
"imageRef":
{
"name": "CentOS 5 Plesk",
"links": [
{
"href": "http://{api_server}/images/test_public_image/",
"rel": "self"
}
],
"id": "test_public_image"
},
"userId": "{user_account_id}",
"flavorRef":
{
"name": "",
"links": [
{
"href": "http://{api_server}/flavors/1/",
"rel": "self"
}
],
"id": "1"
},
"id": "167",
"name": "test_server_create",
"adminPass": "{auto_generated_password}"
"created": "",
"tenantId": null,
"accessIPv4": "{ip_address}",
"accessIPv6": null,
"progress": 0,
"metadata": {}
}
}
</nowiki>
* When a server is in pending status (has not completed the provisioning process), the creation timestamp and hostId that are returned will be empty strings.

'''Failure while trying to create a server with a bad request body'''
:'''POST''' <nowiki>http://{api_server}/servers</nowiki>

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''Request Body:''
<nowiki>
{
"server" :
{
"flavorRef" : "http://{api_server}//flavors/{flavor_id}",
"name" : "{display_server_name}",
"imageRef" : "http://{api_server}//images/{fake_image_id}"
}
}
</nowiki>
''Response Code:''
<pre>HTTP/1.1 400 Bad Request</pre>

''Response Body:''
{
"computeFault":
{
"message": "Bad imageRef",
"code": 400,
"details": ""
}
}

[[Category:Hostway API]]
[[Category:FlexCloud Server API]]



{{#widget:DISQUS
|id=hostway
|uniqid={{PAGENAME}}
|url={{fullurl:{{PAGENAME}}}}
}}

ServerListDetails

2013-04-13T01:04:23Z

Administrator:

This operation will list all [[Server|servers]] including their details.

=='''GET''' /servers/detail?''name=serverName&status=serverStatus&image=imageRef''==

=== Parameters ===
; name - ''string''
: Server name to search for.

; status - ''string''
: Server status to search for. Values: '''BUILD''', '''ACTIVE''', '''SUSPENDED''', '''DELETED''', '''UNKNOWN'''

; image - ''string''
: Absolute URL of the image to filter servers by. ''e.g. <nowiki>http://{api_server}/images/{image_id}/</nowiki>''

=== Result ===
==== JSON ====
<nowiki>
{
"servers":[
{
"status":"{state_status}",
"updated":"",
"hostId":"{host_id}",
"addresses":{
"public":[
{
"version":4,
"addr":"{ip_address}"
}
],
"private":[
{
"version":4,
"addr":"{ip_address}"
}
]
},
"links":[
{
"href":"http://{api_server}/servers/{server_id}/",
"rel":"self"
}
],
"image":{
"name":"{display_image_name}",
"links":[
{
"href":"http://{api_server}/images/{image_id}/",
"rel":"self"
}
],
"id":"{image_id}"
},
"userId":"{user_account_id}",
"flavor":{
"name":"{display_flavor_name}",
"links":[
{
"href":"http://{api_server}/flavors/{flavor_id}/",
"rel":"self"
}
],
"id":{flavor_id}
},
"id":"{server_id}",
"name":"{display_server_name}",
"created":"2011-12-05T12:51:28",
"tenantId":"",
"accessIPv4":"{ip_address}",
"accessIPv6":"",
"progress":100,
"metadata":{
}
},
{
"status":"{state_status}",
"updated":"",
"hostId":"{host_id}",
"addresses":{
"public":[
{
"version":4,
"addr":"{ip_address}"
}
],
"private":[
{
"version":4,
"addr":"{ip_address}"
}
]
},
"links":[
{
"href":"http://{api_server}/servers/{server_id}/",
"rel":"self"
}
],
"image":{
"name":"{display_image_name}",
"links":[
{
"href":"http://{api_server}/images/{image_id}/",
"rel":"self"
}
],
"id":"{image_id}"
},
"userId":"{user_account_id}",
"flavor":{
"name":"{display_flavor_name}",
"links":[
{
"href":"http://{server_name}/flavors/{flavor_id}/",
"rel":"self"
}
],
"id":{flavor_id}
},
"id":"{server_id}",
"name":"{display_server_name}",
"created":"2011-11-17T10:14:58",
"tenantId":"",
"accessIPv4":"{ip_address}",
"accessIPv6":"",
"progress":100,
"metadata":{
}
}
]
}
</nowiki>

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

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

; status - ''string''
: Current state of the server. Values: '''BUILD''', '''ACTIVE''', '''SUSPENDED''', '''DELETED''', '''UNKNOWN'''

; hostId - ''string''
: Id of the physical host this virtual machine is running on.

; userId - ''string''
: Unique identifier for the owner of this server.

; name - ''string''
: Display name for this server.

; created - ''string''
: The date and time this server was created. ISO 8601 format, YYYY-MM-DDTHH:MM:SS.

; accessIPv4 - ''string''
: The default included public IPv4 address.

; progress - ''number''
: The current progress of this server while in BUILD status. The value is in the range of 0 - 100, but currently will only be 0, 50 or 100.

; metadata - ''object''
: Unused - always an empty object.

; tenantId
: Unused - always null.

; accessIPv6
: Unused - always null.

; updated
: Unused - always null.

===== addresses =====
; addresses.public.version - ''number''
: IP version of this address. Values: '''4'''

; addresses.public.addr = ''string''
: Public IP address of this server

; addresses.private.version - ''number''
: IP version of this address. Values: '''4'''

; addresses.private.addr - ''string''
: Private IP address of this server

===== image =====
; image.name - ''string''
: The display name of the image this server is based on.

; image.links - ''list''
: [[Hypermedia]] for the image.

; image.id - ''string''
: Unique identifier for image this server is based on.

===== flavor =====
; flavor.name - ''string''
: The display name of the flavor this server is based on.

; flavor.links - ''list''
: [[Hypermedia]] for the flavor.

; flavor.id - ''string''
: Unique identifier for flavor this server is based on.

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

=== Examples ===
'''Successfully get server list with details'''
:'''GET''' /servers/detail
''- Response:''
''OK (200)'':
<nowiki>
{
"servers":[
{
"status":"ACTIVE",
"updated":"",
"hostId":"{host_id}",
"addresses":{
"public":[
{
"version":4,
"addr":"{ip_address}"
}
],
"private":[
{
"version":4,
"addr":"{ip_address}"
}
]
},
"links":[
{
"href":"http://{server_name}/servers/test_server_0013/",
"rel":"self"
}
],
"image":{
"name":"Ubuntu 10.10 x64",
"links":[
{
"href":"http://{server_name}/images/test_ubuntu_image/",
"rel":"self"
}
],
"id":"test_ubuntu_image"
},
"userId":"{user_account_id}",
"flavor":{
"name":"1024MB Server3",
"links":[
{
"href":"http://{server_name}/flavors/3/",
"rel":"self"
}
],
"id":3
},
"id":"test_server_0013",
"name":"test_server_updated",
"created":"2011-12-05T12:51:28",
"tenantId":"",
"accessIPv4":"{ip_address}",
"accessIPv6":"",
"progress":100,
"metadata":{
}
},
{
"status":"ACTIVE",
"updated":"",
"hostId":"{host_id}",
"addresses":{
"public":[
{
"version":4,
"addr":"{ip_address}"
}
],
"private":[
{
"version":4,
"addr":"{ip_address}"
}
]
},
"links":[
{
"href":"http://{server_name}/servers/test_server_0015/",
"rel":"self"
}
],
"image":{
"name":"Windows 2008 R2 Standard",
"links":[
{
"href":"http://{server_name}/images/test_windows_image/",
"rel":"self"
}
],
"id":"test_windows_image"
},
"userId":"{user_account_id}",
"flavor":{
"name":"1024MB Server3",
"links":[
{
"href":"http://{server_name}/flavors/3/",
"rel":"self"
}
],
"id":3
},
"id":"test_server_0015",
"name":"test_server_created",
"created":"2011-11-17T10:14:58",
"tenantId":"",
"accessIPv4":"{ip_address}",
"accessIPv6":"",
"progress":100,
"metadata":{
}
}
]
}
</nowiki>

'''Failure while trying to make an unauthorized call'''
''- Response: Unauthorized (401)'':
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.

[[Category:Hostway API]]
[[Category:FlexCloud Server API]]



{{#widget:DISQUS
|id=hostway
|uniqid={{PAGENAME}}
|url={{fullurl:{{PAGENAME}}}}
}}

ServerList

2013-04-13T01:03:37Z

Administrator:

This operation will list all [[Server|servers]].

=='''GET''' /servers?''name=serverName&status=serverStatus&image=imageRef''==

=== Parameters ===
; name - ''string''
: ''Optional'' Server name to search for.

; status - ''string''
: ''Optional'' Server status to search for. Values: '''BUILD''', '''ACTIVE''', '''SUSPENDED''', '''DELETED''', '''UNKNOWN'''

; image - ''string''
: ''Optional'' Absolute URL of the image to filter servers by. ''e.g. http(s)://{api_server}/images/{image_id}/''

=== Result ===
==== JSON ====
<nowiki>
{
"servers":[
{
"id":"{server_id}",
"links":[
{
"href":"http://{api_server}/servers/{server_id}/",
"rel":"self"
}
]
},
{
"id":"{server_id}",
"links":[
{
"href":"http://{api_server}/servers/{server_id}/",
"rel":"self"
}
]
}
]
}</nowiki>

; id - ''string''
: Unique identifier for this server.

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

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

=== Examples ===
'''Successfully list servers'''
:'''GET''' http(s)://{api_server}/servers

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

''Response Body:''
<nowiki>
{
"servers" : [
{
"id": "test_server_0001",
"links": [
{
"href": "http://{api_server}/servers/test_server_0001/",
"rel": "self"
}
]
},
{
"id": "test_server_0013",
"links": [
{
"href": "http://{api_server}/servers/test_server_0013/",
"rel": "self"
}
]
},
{
"id": "test_server_0015",
"links": [
{
"href": "http://{api_server}/servers/test_server_0015/",
"rel": "self"
}
]
}
]
}</nowiki>

'''Failure while trying to make unauthorized access'''
:'''GET''' <nowiki>http://{api_server}/servers</nowiki>

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded fake_authentication_string

''Response Code:''
<pre>HTTP/1.1 401 Unauthorized</pre>

''Response Body:''
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.

[[Category:Hostway API]]
[[Category:FlexCloud Server API]]



{{#widget:DISQUS
|id=hostway
|uniqid={{PAGENAME}}
|url={{fullurl:{{PAGENAME}}}}
}}

ServerList

2013-04-13T00:59:25Z

Administrator:

This operation returns a list of all [[Server|servers]].

=='''GET''' /servers?''name=serverName&status=serverStatus&image=imageRef''==

=== Parameters ===
; name - ''string''
: ''Optional'' Server name to search for.

; status - ''string''
: ''Optional'' Server status to search for. Values: '''BUILD''', '''ACTIVE''', '''SUSPENDED''', '''DELETED''', '''UNKNOWN'''

; image - ''string''
: ''Optional'' Absolute URL of the image to filter servers by. ''e.g. http(s)://{api_server}/images/{image_id}/''

=== Result ===
==== JSON ====
<nowiki>
{
"servers":[
{
"id":"{server_id}",
"links":[
{
"href":"http://{api_server}/servers/{server_id}/",
"rel":"self"
}
]
},
{
"id":"{server_id}",
"links":[
{
"href":"http://{api_server}/servers/{server_id}/",
"rel":"self"
}
]
}
]
}</nowiki>

; id - ''string''
: Unique identifier for this server.

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

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

=== Examples ===
'''Successfully list servers'''
:'''GET''' http(s)://{api_server}/servers

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

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

''Response Body:''
<nowiki>
{
"servers" : [
{
"id": "test_server_0001",
"links": [
{
"href": "http://{api_server}/servers/test_server_0001/",
"rel": "self"
}
]
},
{
"id": "test_server_0013",
"links": [
{
"href": "http://{api_server}/servers/test_server_0013/",
"rel": "self"
}
]
},
{
"id": "test_server_0015",
"links": [
{
"href": "http://{api_server}/servers/test_server_0015/",
"rel": "self"
}
]
}
]
}</nowiki>

'''Failure while trying to make unauthorized access'''
:'''GET''' <nowiki>http://{api_server}/servers</nowiki>

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded fake_authentication_string

''Response Code:''
<pre>HTTP/1.1 401 Unauthorized</pre>

''Response Body:''
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.

[[Category:Hostway API]]
[[Category:FlexCloud Server API]]



{{#widget:DISQUS
|id=hostway
|uniqid={{PAGENAME}}
|url={{fullurl:{{PAGENAME}}}}
}}