Create Firewall Group Rule - Revision history

Mike.robski: 1 revision: Release 86

2013-10-11T17:00:56Z

1 revision: Release 86

Youngbae.oh at 20:04, 29 August 2013

2013-08-29T20:04:15Z

Show changes

Mike.robski: 1 revision

2013-05-24T15:25:00Z

1 revision

Mike.robski at 13:21, 20 May 2013

2013-05-20T13:21:46Z

Administrator at 01:40, 13 April 2013

2013-04-13T01:40:01Z

Mike.robski at 20:59, 14 December 2012

2012-12-14T20:59:17Z

Mike.robski at 20:48, 14 December 2012

2012-12-14T20:48:59Z

Mike.robski at 20:45, 14 December 2012

2012-12-14T20:45:28Z

Administrator: Created page with "This operation will create a new firewall group rule. ='''POST''' /os-security-group-rules= This operation will create a new firewall group rule. == Request == === JSON === ..."

2012-07-04T21:35:58Z

Created page with "This operation will create a new firewall group rule. ='''POST''' /os-security-group-rules= This operation will create a new firewall group rule. == Request == === JSON === ..."

New page

This operation will create a new firewall group rule.

='''POST''' /os-security-group-rules=
This operation will create a new firewall group rule.

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



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

← Older revision		Revision as of 01:40, 13 April 2013
Line 2:		Line 2:

	=='''POST''' /os-security-group-rules==		=='''POST''' /os-security-group-rules==
−	~~This operation will create a new firewall group rule.~~

	=== Request ===		=== Request ===

← Older revision		Revision as of 20:45, 14 December 2012
Line 361:		Line 361:
	does not understand how to supply the credentials required.		does not understand how to supply the credentials required.

		+	= Dynamic DNS API endpoints =

	<!-- THIS CODE ENABLES DISQUS COMMENTS ON THE PAGE - DELETE TO DISABLE COMMENTING-->		<!-- THIS CODE ENABLES DISQUS COMMENTS ON THE PAGE - DELETE TO DISABLE COMMENTING-->

@@ Line 1: / Line 1: @@
 This operation will create a new firewall group rule.
-=='''POST''' /os-security-group-rules==
+='''POST''' /os-security-group-rules=
-=== Request ===
+== Request ==
-==== JSON ====
+=== JSON ===
   <nowiki>
+  {
@@ Line 16: / Line 17: @@
   }</nowiki>
-=====security_group_rule=====
+====security_group_rule====
 ; from_port - ''int''
 : Start port number.
@@ Line 32: / Line 33: @@
 : Parent group identifier for this rule.
-=== Response ===
+== Response ==
-==== JSON ====
+=== JSON ===
   <nowiki>
+  {
@@ Line 68: / Line 69: @@
 </nowiki>
-=====security_group_rule=====
+====security_group_rule====
 ; from_port - ''int''
 : Start port number.
@@ Line 93: / Line 94: @@
 : Firewall group rule unique identifier.
-=== Response Codes ===
+== Response Codes ==
 ; Success
 : ''HTTP/1.1 201 Created''
@@ Line 101: / Line 102: @@
 : ''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 ===
+== Examples ==
 '''Successfully create a new firewall group rule'''
 :'''POST''' http(s)://{api_server}//os-security-group-rules
@@ Line 242: / Line 243: @@
         "message": "Invalid",
         "code": 400,
-        "details": ""
+        "details": "",
+     }
   }</nowiki>
@@ Line 274: / Line 276: @@
         "message": "FirewallRuleError",
         "code": 400,
-        "details": "Invalid ports"
+        "details": "Invalid ports",
+     }
   }</nowiki>
@@ Line 306: / Line 309: @@
         "message": "Invalid",
         "code": 400,
-        "details": ""
+        "details": "",
+     }
   }</nowiki>
@@ Line 338: / Line 342: @@
         "message": "FirewallRuleError",
         "code": 400,
-        "details": "Source IP address is invalid"
+        "details": "Source IP address is invalid",
+     }
   }</nowiki>
@@ Line 359: / Line 364: @@
       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]]

@@ Line 361: / Line 361: @@
       does not understand how to supply the credentials required.
-= Dynamic DNS API endpoints =
 <!--  THIS CODE ENABLES DISQUS COMMENTS ON THE PAGE - DELETE TO DISABLE COMMENTING-->