Mike.robski: 1 revision: Release 86

2013-10-11T17:00:57Z

1 revision: Release 86

Youngbae.oh at 19:57, 29 August 2013

2013-08-29T19:57:39Z

New page

This operation will update displayname and/or descriptin of the specified firewall group.

='''PUT''' /accounts/''{accountId}''/flexcloud/os-security-groups/''{id}''=

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

; id
: The unique identifier of the firewall group.

== Request==
=== JSON ===
<nowiki>
{
"securityGroup" : {
"displayName" : "{firewall_group_display_name}",
"description" : "{firewall_group_description}",
}
} </nowiki>

== Response ==
=== JSON ===
<nowiki>
{
"securityGroup" : {
"displayName" : "{firewall_group_display_name}",
"description" : "{firewall_group_description}",
"links" : [
{
"href" : "http://{api-server}/accounts/{accountId}/flexcloud/os-security-groups/{firewall_group_name}/",
"rel" : "self"
}
],
"rules" : [
{
"fromPort" : "{start_port}",
"toPort" : "{end_port}",
"protocol" : "{ip_protocol}",
"cidr": "0.0.0.0/0",
"id" : "145"
},
{
"fromPort" : "{start_port}",
"toPort" : "{end_port}",
"protocol" : "{ip_protocol}",
"cidr": "127.0.0.1/0",
"id" : "169"
}
],
"servers" : ["{server_id}"],
"accountNumber" : "{user_account_number}",
"id" : "{firewall_group_name}"
}
}</nowiki>

== 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 edit details for specified firewall group'''
:'''PUT''' http(s)://{api_server}/accounts/{accountId}/flexcloud/os-security-groups/group2012May11_OK30Zs7Ju

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

''Request Body:''
<nowiki>
{
"securityGroup" : {
"displayName": "New display name",
"description": "New description",
}</nowiki>

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

''Response Body:''
<nowiki>
{
"securityGroup" : {
"displayName": "New display name",
"description": "New description.",
"links": [
{
"href": "http://{api_server}/accounts/{accountId}/flexcloud/os-security-groups/group2012May11_OK30Zs7Ju/",
"rel": "self"
}
],
"rules": [
{
'toPort': 1111,
'fromPort': 1111,
'protocol': 'TCP',
'id': 145,
'cidr': '0.0.0.0/0'
},
{
'toPort': 80,
'fromPort': 80,
'protocol': 'tcp',
'id': 196,
'cidr': '127.0.0.1/24'
}
],
"id": "group2012May11_OK30Zs7Ju",
"accountNumber": "test_account_120761",
"servers": ["test-server-0003"]
}
}</nowiki>

'''Failure while trying to edit a firewall group that does not exist'''
:'''PUT''' http(s)://{api_server}/accounts/{accountId}/flexcloud/os-security-groups/{<span style="color:red">fake_firewall_group_name</span>}

''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"
}
}

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

Edit Firewall Group - Revision history

Mike.robski: 1 revision: Release 86

Youngbae.oh at 19:57, 29 August 2013