Create Firewall Group - Revision history

Mike.robski: 1 revision: Release 86

2013-10-11T17:00:56Z

1 revision: Release 86

Youngbae.oh: /* Examples */

2013-08-29T15:59:36Z

Examples

Show changes

Mike.robski: 1 revision

2013-05-24T15:25:00Z

1 revision

Mike.robski at 13:20, 20 May 2013

2013-05-20T13:20:36Z

Mike.robski at 20:57, 14 December 2012

2012-12-14T20:57:28Z

Mike.robski at 20:55, 14 December 2012

2012-12-14T20:55:13Z

Mike.robski at 20:39, 14 December 2012

2012-12-14T20:39:38Z

Administrator at 21:33, 4 July 2012

2012-07-04T21:33:42Z

Administrator: Created page with "A Security 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 m..."

2012-07-04T21:31:52Z

Created page with "A Security 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 m..."

New page

A Security 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.

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

== Request ==
=== JSON ===
<nowiki>
{
"security_group" : {
"display_name" : "{firewall_group_display_name}",
"description" : "{firewall_group_description}"
}
}</nowiki>

====security_group====
; display_name - ''string''
: Display name for this firewall group.

; description - ''string''
: Descriptive information for this 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": [],
"name": "{firewall_group_name}",
"account_number": "{user_account_number}",
"servers": []
}
}
</nowiki>

====security_group====
; display_name - ''string''
: Display name for this firewall group.

; description - ''string''
: Descriptive information for this firewall group.

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

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

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

; account_number - ''string''
: The account number this firewall group resource belongs to.

; servers - ''list''
: List of server IDs this security group is assigned to.

== 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'''
:'''POST''' http(s)://{api_server}/os-security-groups

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

''Request Body:''
<nowiki>
{
"security_group" : {
"display_name" : "Test Firewall Group",
"description" : "Test firewall group description."
}
}
</nowiki>

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

''Response Body:''
<nowiki>
{
"security_group" : {
"display_name": "Test Firewall Group",
"description": "Test firewall group description.",
"links": [
{
"href": "http://{api_server}/os-security-groups/group2012May11_OK30Zs7Ju/",
"rel": "self"
}
],
"rules": [],
"name": "group2012May11_OK30Zs7Ju",
"account_number": "test_account_120761",
"servers": []
}
}</nowiki>

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

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

''Request Body:''
{
<span style="color:red">Empty</span>
}

''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 group with an already existing firewall group display name'''
:'''POST''' http(s)://{api_server}/os-security-groups

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

''Request Body:''
<nowiki>
{
"security_group" : {
"display_name" : "Test Firewall Group",
"description" : "Test firewall group description."
}
}</nowiki>

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

''Response Body:''
<nowiki>
{
"computeFault" : {
"message": "GroupNameError",
"code": 400,
"details": "Display name in use"
}
}</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 <span style="color:red">fake_authentication_string</span>

''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 20:55, 14 December 2012
Line 188:		Line 188:


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

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

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

		+
		+	[[Category:API]]

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

← Older revision		Revision as of 21:33, 4 July 2012
Line 1:		Line 1:
−	A Security 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.	+	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.

	='''POST''' /os-security-groups=		='''POST''' /os-security-groups=

@@ Line 1: / Line 1: @@
 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.
-=='''POST''' /os-security-groups==
+='''POST''' /os-security-groups=
 This operation will create a new firewall group.
-=== Request ===
+== Request ==
-==== JSON ====
+=== JSON ===
   <nowiki>
+  {
@@ Line 14: / Line 14: @@
   }</nowiki>
-=====security_group=====
+====security_group====
 ; display_name - ''string''
 : Display name for this firewall group.
@@ Line 21: / Line 21: @@
 : Descriptive information for this firewall group.
-=== Response ===
+== Response ==
-==== JSON ====
+=== JSON ===
   <nowiki>
+{
@@ Line 42: / Line 42: @@
 </nowiki>
-=====security_group=====
+====security_group====
 ; display_name - ''string''
 : Display name for this firewall group.
@@ Line 64: / Line 64: @@
 : List of server IDs this security group is assigned to.
-=== Response Codes ===
+== Response Codes ==
 ; Success
 : ''HTTP/1.1 201 Created''
@@ Line 72: / Line 72: @@
 : ''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'''
 :'''POST''' http(s)://{api_server}/os-security-groups
@@ Line 135: / Line 135: @@
         "message": "Invalid",
         "code": 400,
-        "details": ""
+        "details": "",
+     }
   }</nowiki>
@@ Line 165: / Line 166: @@
         "message": "GroupNameError",
         "code": 400,
-        "details": "Display name in use"
+        "details": "Display name in use",
+     }
   }</nowiki>
@@ Line 186: / Line 188: @@
       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]]