Mike.robski: 1 revision: Release 109

2015-07-24T18:12:59Z

1 revision: Release 109

Velimira.metodieva: /* securityGroupRule */

2015-05-26T13:58:20Z

securityGroupRule

New page

This operation will create a new firewall group rule.

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

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

=== JSON ===
<nowiki>
{
"securityGroupRule" : {
"fromPort": {start_port},
"toPort": {end_port},
"protocol": "{ip_protocol}",
"cidr": "127.0.0.1/24",
"parentGroupId": "{parent_group_id}",
"action": "{action}",
"priority": {priority}
}
}</nowiki>

====securityGroupRule====
; fromPort - ''int''
: Start port number.

; toPort - ''int''
: End port number.

; protocol - ''string''
: IP protocol used. Can be TCP, UDP, AH, ESP, GRE, AH+ESP, or ALL
: AH, ESP, GRE, AH+ESP, ALL protocols don't support port - both should be 0

; cidr - ''string''
: CIDR notation IP address.

; parentGroupId - ''string''
: Parent group identifier for this rule.

; action = ''string''
: rule target action. One of ACCEPT, REJECT or DROP

; priority = ''integer''
: rule priority, starting from 0 lowest priority

== Response ==
=== JSON ===
<nowiki>
{
"securityGroupRule" : {
"fromPort": {start_port},
"protocol": "{ip_protocol}",
"links": [
{
"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/os-security-group-rules/{firewall_group_rule_id}/",
"rel": "self"
}
],
"toPort": {end_port},
"parentGroupId": "{parent_firewall_group_name}",
"cidr": "127.0.0.1/24"
"id": {firewall_group_rule_id}
}
}
</nowiki>

====securityGroupRule====
; fromPort - ''int''
: Start port number.

; protocol - ''string''
: IP protocol used.

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

; toPort - ''int''
: End port number.

; parentGroupId - ''string''
: Parent group identifier for this rule.

; cidr - ''string''
: 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.
: ''HTTP/1.1 404 Not Found'' - The resource does not exist.

== Examples ==
'''Successfully create a new firewall group rule'''
:'''POST''' {{APIBaseURL}}/accounts/{accountId}/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",
"action": "ACCEPT",
"priority": 1
}
} </nowiki>

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

''Response Body:''
<nowiki>
{
"securityGroupRule" : {
"fromPort": 80,
"protocol": "tcp",
"links": [
{
"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/os-security-group-rules/214/",
"rel": "self"
}
],
"toPort": 80,
"parentGroupId": "group2012May11_NpCpS3995",
"cidr": "127.0.0.1/24",
"id": 214
}
} </nowiki>

'''Successfully create a new firewall group rule with an IP without a netmask'''
:'''POST''' {{APIBaseURL}}/accounts/{accountId}/os-security-group-rules

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

''Request Body:''
<nowiki>
{
"securityGroupRule" : {
"fromPort": 80,
"toPort": 80,
"protocol": "TCP",
"cidr": "127.0.0.1",
"parentGroupId": "group2012May11_NpCpS3995"
}
} </nowiki>

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

''Response Body:''
<nowiki>
{
"securityGroupRule" : {
"fromPort": 80,
"protocol": "tcp",
"links": [
{
"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/os-security-group-rules/215/",
"rel": "self"
}
],
"toPort": 80,
"parentGroupId": "group2012May11_NpCpS3995",
"cidr": "127.0.0.1/32",
"id": 215
}
} </nowiki>

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

'''Failure while trying to create a new rule with invalid from and to ports'''
:'''POST''' {{APIBaseURL}}/accounts/{accountId}/os-security-group-rules

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

''Request Body:''
<nowiki>
{
"securityGroupRule" : {
"fromPort": </nowiki>81<nowiki>,
"toPort": </nowiki>80<nowiki>,
"protocol": "tcp",
"cidr": "127.0.0.1/24",
"parentGroupId": "group2012May11_NpCpS3995"
}
}</nowiki>

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

''Response Body:''
<nowiki>
{
"badRequest" : {
"message": "FirewallRuleError",
"code": 400,
"details": "Invalid ports",
"errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
}
}</nowiki>

'''Failure while trying to create a new rule rule with an invalid protocol'''
:'''POST''' {{APIBaseURL}}/accounts/{accountId}/os-security-group-rules

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

''Request Body:''
{
"securityGroupRule" : {
"fromPort": 80,
"toPort": 80,
"protocol": "proto",
"cidr": "127.0.0.1/24",
"parentGroupId": "group2012May11_NpCpS3995"
}
}

''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 rule with an invalid IP address'''
:'''POST''' http(s)://{api_server}/accounts/{accountId}/os-security-group-rules

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

''Request Body:''
{
"securityGroupRule" : {
"fromPort": 80,
"toPort": 80,
"protocol": "tcp",
"cidr": "ip_address",
"parentGroupId": "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",
"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 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.

'''Failure while trying to pass invalid account number'''
:'''POST''' http(s)://{api_server}/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-group-rules ==
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-group-rules</code>

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

Accounts-accountId-os-security-group-rules:POST - Revision history

Mike.robski: 1 revision: Release 109

Velimira.metodieva: /* securityGroupRule */