Accounts-accountId-dedicatedServers-serverId-ipAddresses-ipaddress-natRules-ruleId:GET

From Hostway API Documentation
Jump to: navigation, search

GET /accounts/{accountId}/dedicatedServers/{serverId}/ipAddresses/{ipAddress}/natRules/{ruleId}

Get a specific NAT rule, which is assigned to a specific IP address of a dedicated server

Contents


Request

GET /accounts/{accountId}/dedicatedServers/{serverId}/ipAddresses/{ipAddress}/natRules/{ruleId}

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
ruleId - string
The specific NAT rule Id

Request Headers

Authorization - HTTP Authorization header [1]
The Authentication credentials of the client application.

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 specific NAT rule resource does not exist.

Response Body

{
    "priority": {priority},
    "protocol": "{protocol}",
    "externalPort": {externalPort},
    "port": {port},
    "links": [
        {
            "href": {resourceURL},
            "rel": "self"
        }
    ]
}
 

Parameters

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 this resource. Link to self.

Examples

Success getting a specific NAT rule for a specific dedicated server IP

Request

GET /accounts/test-acount/dedicatedServers/test-server-213/ipAddresses/1.1.1.1/natRules/test-rule-1
 

Response

{
    "priority": 0,
    "protocol": "TCP",
    "externalPort": 1234,
    "port": 4321,
    "links": [
        {
            "href": "https://api.hostway.com/accounts/test-acount/dedicatedServers/test-server-213/ipAddresses/1.1.1.1/natRules/test-rule-1",
            "rel": "self"
        }
    ]
}
 


blog comments powered by Disqus

Personal tools
Namespaces
Variants
Actions
APIs
Navigation
Toolbox