Mike.robski: 1 revision: Release 109

2015-07-24T18:12:59Z

1 revision: Release 109

Jerry.dimitrov at 16:48, 20 April 2015

2015-04-20T16:48:21Z

New page

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''' /accounts/''{accountId}''/os-security-groups=
This operation will create a new firewall group.

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

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

====securityGroup====
; displayName - ''string''
: Display name for this firewall group.

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

== Response ==
=== JSON ===
<nowiki>
{
"securityGroup" : {
"displayName": "{firewall_group_display_name}",
"description": "{firewall_group_description}",
"links": [
{
"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/os-security-groups/{firewall_group_id}/",
"rel": "self"
}
],
"rules": [],
"id": "{firewall_group_id}",
"accountNumber": "{user_account_number}",
"servers": []
}
}</nowiki>

====securityGroup====
; displayName - ''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.

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

; accountNumber - ''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.
: ''HTTP/1.1 409 Conflict'' - The resource already exists.

== Examples ==
'''Successfully create a new firewall group'''
:'''POST''' {{APIBaseURL}}/accounts/{accountId}/os-security-groups

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

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

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

''Response Body:''
<nowiki>
{
"securityGroup" : {
"displayName": "Test Firewall Group",
"description": "Test firewall group description.",
"links": [
{
"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/os-security-groups/group2012May11_OK30Zs7Ju/",
"rel": "self"
}
],
"rules": [],
"id": "group2012May11_OK30Zs7Ju",
"accountNumber": "test_account_120761",
"servers": []
}
}</nowiki>

'''Failure while trying to create a new firewall group with invalid data'''
:'''POST''' {{APIBaseURL}}/accounts/{accountId}/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": "",
"errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
}
}</nowiki>

'''Failure while trying to create a new firewall group with an already existing firewall group display name'''
:'''POST''' {{APIBaseURL}}/accounts/{accountId}/os-security-groups

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

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

''Response Code:''
<pre>HTTP/1.1 409 Conflict</pre>

''Response Body:''
<nowiki>
{
"computeFault" : {
"message": "GroupNameError",
"code": 400,
"details": "Display name in use",
"errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
}
}</nowiki>

'''Failure while trying to make unauthorized access'''
:'''POST''' {{APIBaseURL}}/accounts/{accountId}/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.

'''Failure while trying to pass invalid account number'''
:'''POST''' {{APIBaseURL}}/accounts/fakeId/os-security-groups

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

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

== Alternative URI /accounts/os-security-groups ==
An alternative way to execute this call is to omit the ''accountId'' portion of the URI. In this case the system assumes the request is executed for the account identified in the [[Authentication|authorization header]].

<code>POST /accounts/os-security-groups</code>

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

Accounts-accountId-os-security-groups:POST - Revision history

Mike.robski: 1 revision: Release 109

Jerry.dimitrov at 16:48, 20 April 2015