Cloud Management API 1.5

NetworkGateways

A NetworkGateway is an interface that allows traffic to be routed between networks.

Actions

index

Lists the NetworkGateways available to this account.

URLs
GET /api/network_gateways
HTTP response code
200 OK
Content-type
application/vnd.rightscale.network_gateway;type=collection

Required roles

Parameters

name required type values regexp blank? description
filter no Array * * no See below for valid filter parameters.

Filters

name partial_match? description
cloud_href no Returns NetworkGateways in the specified cloud
name yes The name of the NetworkGateway to filter on.
network_href no Returns NetworkGateways attached to the specified network

Example Responses

Click on a format below to see an example response:

JSON XML
[{
  "links": [
    {"rel":"self","href":"/api/network_gateways/RESOURCE_3788005864;2988888299"},
    {"rel":"cloud","href":"/api/clouds/888"},
    {"rel":"network","href":"/api/networks/RESOURCE_1587205178;2879932595"}
  ],
  "name": "NAME_2380395070",
  "description": null,
  "resource_uid": "RESOURCE_3788005864",
  "created_at": "2018/10/16 16:04:42 +0000",
  "updated_at": "2018/10/16 16:04:42 +0000",
  "state": "available",
  "actions": [

  ],
  "type": "internet"
},{
  "links": [
    {"rel":"self","href":"/api/network_gateways/RESOURCE_1340416633;1509109393"},
    {"rel":"cloud","href":"/api/clouds/888"},
    {"rel":"network","href":"/api/networks/RESOURCE_3193593752;3044363136"}
  ],
  "name": "NAME_3833211234",
  "description": null,
  "resource_uid": "RESOURCE_1340416633",
  "created_at": "2018/10/16 16:04:44 +0000",
  "updated_at": "2018/10/16 16:04:44 +0000",
  "state": "available",
  "actions": [

  ],
  "type": "internet"
}]
<?xml version="1.0" encoding="UTF-8"?>
<network_gateways>
  <network_gateway>
    <links>
      <link rel="self" href="/api/network_gateways/RESOURCE_3788005864;2988888299"/>
      <link rel="cloud" href="/api/clouds/888"/>
      <link rel="network" href="/api/networks/RESOURCE_1587205178;2879932595"/>
    </links>
    <name>NAME_2380395070</name>
    <description/>
    <resource_uid>RESOURCE_3788005864</resource_uid>
    <created_at>2018/10/16 16:04:42 +0000</created_at>
    <updated_at>2018/10/16 16:04:42 +0000</updated_at>
    <state>available</state>
    <actions/>
    <type>internet</type>
  </network_gateway>
  <network_gateway>
    <links>
      <link rel="self" href="/api/network_gateways/RESOURCE_1340416633;1509109393"/>
      <link rel="cloud" href="/api/clouds/888"/>
      <link rel="network" href="/api/networks/RESOURCE_3193593752;3044363136"/>
    </links>
    <name>NAME_3833211234</name>
    <description/>
    <resource_uid>RESOURCE_1340416633</resource_uid>
    <created_at>2018/10/16 16:04:44 +0000</created_at>
    <updated_at>2018/10/16 16:04:44 +0000</updated_at>
    <state>available</state>
    <actions/>
    <type>internet</type>
  </network_gateway>
</network_gateways>

show

Show information about a single NetworkGateway.

URLs
GET /api/network_gateways/:id
HTTP response code
200 OK
Content-type
application/vnd.rightscale.network_gateway

Required roles

Example Responses

Click on a format below to see an example response:

JSON XML
{
  "links": [
    {"rel":"self","href":"/api/network_gateways/RESOURCE_3788005864;2988888299"},
    {"rel":"cloud","href":"/api/clouds/888"},
    {"rel":"network","href":"/api/networks/RESOURCE_1587205178;2879932595"}
  ],
  "name": "NAME_2380395070",
  "description": null,
  "resource_uid": "RESOURCE_3788005864",
  "created_at": "2018/10/16 16:04:42 +0000",
  "updated_at": "2018/10/16 16:04:42 +0000",
  "state": "available",
  "actions": [

  ],
  "type": "internet"
}
<?xml version="1.0" encoding="UTF-8"?>
<network_gateway>
  <links>
    <link rel="self" href="/api/network_gateways/RESOURCE_3788005864;2988888299"/>
    <link rel="cloud" href="/api/clouds/888"/>
    <link rel="network" href="/api/networks/RESOURCE_1587205178;2879932595"/>
  </links>
  <name>NAME_2380395070</name>
  <description/>
  <resource_uid>RESOURCE_3788005864</resource_uid>
  <created_at>2018/10/16 16:04:42 +0000</created_at>
  <updated_at>2018/10/16 16:04:42 +0000</updated_at>
  <state>available</state>
  <actions/>
  <type>internet</type>
</network_gateway>

create

Create a new NetworkGateway.

URLs
POST /api/network_gateways
HTTP response code
201 Created
Content-type
application/vnd.rightscale.network_gateway

Required roles

Parameters

name required type values regexp blank? description
network_gateway yes Hash * * no
network_gateway[cloud_href] yes String * * no The cloud to create the NetworkGateway in.
network_gateway[description] no String * * yes The description to be set on the NetworkGateway.
network_gateway[name] yes String * * no The name to be set on the NetworkGateway.
network_gateway[type] yes String vpn, internet * no The type of the NetworkGateway.

Example Responses

Click on a format below to see an example response:

JSON XML
{
  "links": [
    {"rel":"self","href":"/api/network_gateways/RESOURCE_3788005864;2988888299"},
    {"rel":"cloud","href":"/api/clouds/888"},
    {"rel":"network","href":"/api/networks/RESOURCE_1587205178;2879932595"}
  ],
  "name": "NAME_2380395070",
  "description": null,
  "resource_uid": "RESOURCE_3788005864",
  "created_at": "2018/10/16 16:04:42 +0000",
  "updated_at": "2018/10/16 16:04:42 +0000",
  "state": "available",
  "actions": [

  ],
  "type": "internet"
}
<?xml version="1.0" encoding="UTF-8"?>
<network_gateway>
  <links>
    <link rel="self" href="/api/network_gateways/RESOURCE_3788005864;2988888299"/>
    <link rel="cloud" href="/api/clouds/888"/>
    <link rel="network" href="/api/networks/RESOURCE_1587205178;2879932595"/>
  </links>
  <name>NAME_2380395070</name>
  <description/>
  <resource_uid>RESOURCE_3788005864</resource_uid>
  <created_at>2018/10/16 16:04:42 +0000</created_at>
  <updated_at>2018/10/16 16:04:42 +0000</updated_at>
  <state>available</state>
  <actions/>
  <type>internet</type>
</network_gateway>

update

Update an existing NetworkGateway.

URLs
PUT /api/network_gateways/:id
HTTP response code
204 No Content
Content-type
application/vnd.rightscale.network_gateway

Required roles

Parameters

name required type values regexp blank? description
network_gateway yes Hash * * no
network_gateway[description] no String * * yes The description to be set on the NetworkGateway.
network_gateway[name] no String * * no The name to be set on the NetworkGateway.
network_gateway[network_href] no String * * yes Pass a blank string to detach from the specified Network, or pass a valid Network href to attach to the specified network.

Example Responses

Click on a format below to see an example response:

JSON XML
{
  "links": [
    {"rel":"self","href":"/api/network_gateways/RESOURCE_3788005864;2988888299"},
    {"rel":"cloud","href":"/api/clouds/888"},
    {"rel":"network","href":"/api/networks/RESOURCE_1587205178;2879932595"}
  ],
  "name": "NAME_2380395070",
  "description": null,
  "resource_uid": "RESOURCE_3788005864",
  "created_at": "2018/10/16 16:04:42 +0000",
  "updated_at": "2018/10/16 16:04:42 +0000",
  "state": "available",
  "actions": [

  ],
  "type": "internet"
}
<?xml version="1.0" encoding="UTF-8"?>
<network_gateway>
  <links>
    <link rel="self" href="/api/network_gateways/RESOURCE_3788005864;2988888299"/>
    <link rel="cloud" href="/api/clouds/888"/>
    <link rel="network" href="/api/networks/RESOURCE_1587205178;2879932595"/>
  </links>
  <name>NAME_2380395070</name>
  <description/>
  <resource_uid>RESOURCE_3788005864</resource_uid>
  <created_at>2018/10/16 16:04:42 +0000</created_at>
  <updated_at>2018/10/16 16:04:42 +0000</updated_at>
  <state>available</state>
  <actions/>
  <type>internet</type>
</network_gateway>

destroy

Delete an existing NetworkGateway.

URLs
DELETE /api/network_gateways/:id
HTTP response code
204 No Content
Content-type
application/vnd.rightscale.network_gateway

Required roles

Example Responses

Click on a format below to see an example response:

JSON XML
{
  "links": [
    {"rel":"self","href":"/api/network_gateways/RESOURCE_3788005864;2988888299"},
    {"rel":"cloud","href":"/api/clouds/888"},
    {"rel":"network","href":"/api/networks/RESOURCE_1587205178;2879932595"}
  ],
  "name": "NAME_2380395070",
  "description": null,
  "resource_uid": "RESOURCE_3788005864",
  "created_at": "2018/10/16 16:04:42 +0000",
  "updated_at": "2018/10/16 16:04:42 +0000",
  "state": "available",
  "actions": [

  ],
  "type": "internet"
}
<?xml version="1.0" encoding="UTF-8"?>
<network_gateway>
  <links>
    <link rel="self" href="/api/network_gateways/RESOURCE_3788005864;2988888299"/>
    <link rel="cloud" href="/api/clouds/888"/>
    <link rel="network" href="/api/networks/RESOURCE_1587205178;2879932595"/>
  </links>
  <name>NAME_2380395070</name>
  <description/>
  <resource_uid>RESOURCE_3788005864</resource_uid>
  <created_at>2018/10/16 16:04:42 +0000</created_at>
  <updated_at>2018/10/16 16:04:42 +0000</updated_at>
  <state>available</state>
  <actions/>
  <type>internet</type>
</network_gateway>