Mike.robski: 1 revision: Release 111

2015-09-18T17:15:15Z

1 revision: Release 111

Dinh.anh: /* Parameters */

2015-07-01T13:55:31Z

Parameters

New page

= GET /accounts/{accountId}/dedicatedServers/{serverId}/ipAddresses/{ipAddress}/natRules =
Get all NAT rules, which are assigned to a specific IP address of a dedicated server
__TOC__

== Request ==
<code>GET /accounts/{accountId}/dedicatedServers/{serverId}/ipAddresses/{ipAddress}/natRules</code>

==== Request Parameters ====
; accountId - ''string''
: The user account owning the dedicated server
; serverId - ''string''
: The specified dedicated server Id
; ipAddress - ''string''
: The specified IP address of the dedicated server

=== Request Headers ===
{{Authorization}}

== Response ==

=== Status Code ===
; 200 OK
: Success

; 401 Unauthorized
: The supplied credentials are invalid or do not provide permissions for this operation.

; 403 Forbidden
: The authorized user does not have permissions to access the resource.

; 404 Not Found
: The IP address, dedicated server or account does not exist.

=== Response Body ===
<nowiki>
{
"list": [
{
"priority": {priority},
"protocol": "{protocol}",
"externalPort": {externalPort},
"port": {port},
"links": [
{
"href": {ruleResourceURL},
"rel": "self"
}
]
}
],
"links": [
{
"href": "{resourceURL}",
"rel": "self"
}
]

}
</nowiki>

==== Parameters ====
; list - ''list''
: A collection of dictionaries containing information about the NAT rules

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

:; protocol - ''string''
:: TCP, UDP, AH, ESP, GRE, AH+ESP or ALL

:; port - ''integer''
:: internal port

:; externalPort - ''integer''
:: external port

:; links - ''list''
:: [[Hypermedia]] for the individual NAT rule resource. Links to [[Accounts-accountId-dedicatedServers-serverId-ipAddresses-ipaddress-natRules-ruleId:GET|NAT rule]].

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

== Examples ==

=== Success getting a list of NAT rules for a specific dedicated server IP ===
'''Request'''
<nowiki>
GET /accounts/test-acount/dedicatedServers/test-server-213/ipAddresses/1.1.1.1/natRules
</nowiki>

'''Response'''
<nowiki>
{
"list": [
{
"priority": 0,
"protocol": "TCP",
"externalPort": 1234,
"port": 4321,
"links": [
{
"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/test-acount/dedicatedServers/test-server-213/ipAddresses/1.1.1.1/natRules/test-rule-1",
"rel": "self"
}
]
},
{
"priority": 0,
"protocol": "UDP",
"externalPort": 1111,
"port": 2222,
"links": [
{
"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/test-acount/dedicatedServers/test-server-213/ipAddresses/1.1.1.1/natRules/test-rule-2",
"rel": "self"
}
]
}
],
"links": [
{
"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/test-acount/dedicatedServers/test-server-213/ipAddresses/1.1.1.1/natRules/",
"rel": "self"
}
]
}
</nowiki>

{{disqus}}
[[Category:Dedicated Server API]]

Accounts-accountId-dedicatedServers-serverId-ipAddresses-ipaddress-natRules:GET - Revision history

Mike.robski: 1 revision: Release 111

Dinh.anh: /* Parameters */