View Firewall Group Details - Revision history

Mike.robski: 1 revision: Release 86

2013-10-11T17:00:56Z

1 revision: Release 86

Youngbae.oh at 19:58, 29 August 2013

2013-08-29T19:58:43Z

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:12Z

Administrator at 01:35, 13 April 2013

2013-04-13T01:35:05Z

Mike.robski at 22:40, 14 December 2012

2012-12-14T22:40:50Z

Mike.robski at 20:48, 14 December 2012

2012-12-14T20:48:21Z

Mike.robski: Reverted edits by Mike.robski (talk) to last revision by Administrator

2012-12-14T20:46:34Z

Reverted edits by Mike.robski (talk) to last revision by Administrator

Mike.robski at 20:46, 14 December 2012

2012-12-14T20:46:02Z

Administrator: Created page with "This operation will list the details for the specified firewall group. ='''GET''' /os-security-groups/'''name'''= This operation will list the details for the specified fire..."

2012-07-04T21:34:50Z

Created page with "This operation will list the details for the specified firewall group. ='''GET''' /os-security-groups/'''name'''= This operation will list the details for the specified fire..."

New page

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

='''GET''' /os-security-groups/'''name'''=
This operation will list the details for the specified firewall group.

== 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/{<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": ""
}
}

'''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 <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 01:35, 13 April 2013
Line 1:		Line 1:
−	~~=='''GET''' /os-security-groups/'''name'''==~~
	This operation will list the details for the specified firewall group.		This operation will list the details for the specified firewall group.
		+
		+	=='''GET''' /os-security-groups/'''name'''==

	=== Parameters ===		=== Parameters ===

← Older revision		Revision as of 20:48, 14 December 2012
Line 159:		Line 159:
	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 20:46, 14 December 2012
Line 159:		Line 159:
	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-->

← Older revision		Revision as of 20:46, 14 December 2012
Line 159:		Line 159:
	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 list the details for the specified firewall group.
-=='''GET''' /os-security-groups/'''name'''==
+='''GET''' /os-security-groups/'''name'''=
-=== Parameters ===
+== Parameters ==
 ; name
 : The unique identifier of the firewall group.
-=== Response ===
+== Response ==
-==== JSON ====
+=== JSON ===
   <nowiki>
+  {
@@ Line 43: / Line 44: @@
 </nowiki>
-=====security_group=====
+====security_group====
 ; display name - ''string''
 : The display name of the firewall group.
@@ Line 65: / Line 66: @@
 : The name of this firewall group.*(Unique identifier for this firewall group.)
-=== Response Codes ===
+== Response Codes ==
 ; Success
 : ''HTTP/1.1 200 OK''
@@ Line 73: / Line 74: @@
 :''HTTP/1.1 404 Not Found'' - The resource does not exist.
-=== Examples ===
+== Examples ==
 '''Successfully list details for specified firewall group'''
 :'''GET''' http(s)://{api_server}/os-security-groups/group2012May11_OK30Zs7Ju
@@ Line 136: / Line 137: @@
            "message": "Resource not found",
            "code": 404,
-           "details": ""
+           "details": "",
+        }
+  }
@@ Line 160: / Line 162: @@
 [[Category:Hostway API]]
 [[Category:FlexCloud Server API]]