Cloud Management API 1.5

NetworkGateways

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

Actions

index
show
create
update
destroy

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

observer

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_1511444377;1060372669"},
    {"rel":"cloud","href":"/api/clouds/888"},
    {"rel":"network","href":"/api/networks/RESOURCE_3622956618;2458063335"}
  ],
  "name": "NAME_22179362",
  "description": null,
  "resource_uid": "RESOURCE_1511444377",
  "created_at": "2023/10/09 11:06:02 +0000",
  "updated_at": "2023/10/09 11:06:02 +0000",
  "state": "available",
  "actions": [

  ],
  "type": "internet"
},{
  "links": [
    {"rel":"self","href":"/api/network_gateways/RESOURCE_3687576838;2370672228"},
    {"rel":"cloud","href":"/api/clouds/888"},
    {"rel":"network","href":"/api/networks/RESOURCE_4013535701;978368541"}
  ],
  "name": "NAME_3418592007",
  "description": null,
  "resource_uid": "RESOURCE_3687576838",
  "created_at": "2023/10/09 11:06:03 +0000",
  "updated_at": "2023/10/09 11:06:03 +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_1511444377;1060372669"/>
      <link rel="cloud" href="/api/clouds/888"/>
      <link rel="network" href="/api/networks/RESOURCE_3622956618;2458063335"/>
    </links>
    <name>NAME_22179362</name>
    <description/>
    <resource_uid>RESOURCE_1511444377</resource_uid>
    <created_at>2023/10/09 11:06:02 +0000</created_at>
    <updated_at>2023/10/09 11:06:02 +0000</updated_at>
    <state>available</state>
    <actions/>
    <type>internet</type>
  </network_gateway>
  <network_gateway>
    <links>
      <link rel="self" href="/api/network_gateways/RESOURCE_3687576838;2370672228"/>
      <link rel="cloud" href="/api/clouds/888"/>
      <link rel="network" href="/api/networks/RESOURCE_4013535701;978368541"/>
    </links>
    <name>NAME_3418592007</name>
    <description/>
    <resource_uid>RESOURCE_3687576838</resource_uid>
    <created_at>2023/10/09 11:06:03 +0000</created_at>
    <updated_at>2023/10/09 11:06:03 +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

observer

Example Responses

Click on a format below to see an example response:

JSON XML

{
  "links": [
    {"rel":"self","href":"/api/network_gateways/RESOURCE_1511444377;1060372669"},
    {"rel":"cloud","href":"/api/clouds/888"},
    {"rel":"network","href":"/api/networks/RESOURCE_3622956618;2458063335"}
  ],
  "name": "NAME_22179362",
  "description": null,
  "resource_uid": "RESOURCE_1511444377",
  "created_at": "2023/10/09 11:06:02 +0000",
  "updated_at": "2023/10/09 11:06:02 +0000",
  "state": "available",
  "actions": [

  ],
  "type": "internet"
}

<?xml version="1.0" encoding="UTF-8"?>
<network_gateway>
  <links>
    <link rel="self" href="/api/network_gateways/RESOURCE_1511444377;1060372669"/>
    <link rel="cloud" href="/api/clouds/888"/>
    <link rel="network" href="/api/networks/RESOURCE_3622956618;2458063335"/>
  </links>
  <name>NAME_22179362</name>
  <description/>
  <resource_uid>RESOURCE_1511444377</resource_uid>
  <created_at>2023/10/09 11:06:02 +0000</created_at>
  <updated_at>2023/10/09 11:06:02 +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

security_manager

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_1511444377;1060372669"},
    {"rel":"cloud","href":"/api/clouds/888"},
    {"rel":"network","href":"/api/networks/RESOURCE_3622956618;2458063335"}
  ],
  "name": "NAME_22179362",
  "description": null,
  "resource_uid": "RESOURCE_1511444377",
  "created_at": "2023/10/09 11:06:02 +0000",
  "updated_at": "2023/10/09 11:06:02 +0000",
  "state": "available",
  "actions": [

  ],
  "type": "internet"
}

<?xml version="1.0" encoding="UTF-8"?>
<network_gateway>
  <links>
    <link rel="self" href="/api/network_gateways/RESOURCE_1511444377;1060372669"/>
    <link rel="cloud" href="/api/clouds/888"/>
    <link rel="network" href="/api/networks/RESOURCE_3622956618;2458063335"/>
  </links>
  <name>NAME_22179362</name>
  <description/>
  <resource_uid>RESOURCE_1511444377</resource_uid>
  <created_at>2023/10/09 11:06:02 +0000</created_at>
  <updated_at>2023/10/09 11:06:02 +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

security_manager

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_1511444377;1060372669"},
    {"rel":"cloud","href":"/api/clouds/888"},
    {"rel":"network","href":"/api/networks/RESOURCE_3622956618;2458063335"}
  ],
  "name": "NAME_22179362",
  "description": null,
  "resource_uid": "RESOURCE_1511444377",
  "created_at": "2023/10/09 11:06:02 +0000",
  "updated_at": "2023/10/09 11:06:02 +0000",
  "state": "available",
  "actions": [

  ],
  "type": "internet"
}

<?xml version="1.0" encoding="UTF-8"?>
<network_gateway>
  <links>
    <link rel="self" href="/api/network_gateways/RESOURCE_1511444377;1060372669"/>
    <link rel="cloud" href="/api/clouds/888"/>
    <link rel="network" href="/api/networks/RESOURCE_3622956618;2458063335"/>
  </links>
  <name>NAME_22179362</name>
  <description/>
  <resource_uid>RESOURCE_1511444377</resource_uid>
  <created_at>2023/10/09 11:06:02 +0000</created_at>
  <updated_at>2023/10/09 11:06:02 +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

security_manager

Example Responses

Click on a format below to see an example response:

JSON XML

{
  "links": [
    {"rel":"self","href":"/api/network_gateways/RESOURCE_1511444377;1060372669"},
    {"rel":"cloud","href":"/api/clouds/888"},
    {"rel":"network","href":"/api/networks/RESOURCE_3622956618;2458063335"}
  ],
  "name": "NAME_22179362",
  "description": null,
  "resource_uid": "RESOURCE_1511444377",
  "created_at": "2023/10/09 11:06:02 +0000",
  "updated_at": "2023/10/09 11:06:02 +0000",
  "state": "available",
  "actions": [

  ],
  "type": "internet"
}

<?xml version="1.0" encoding="UTF-8"?>
<network_gateway>
  <links>
    <link rel="self" href="/api/network_gateways/RESOURCE_1511444377;1060372669"/>
    <link rel="cloud" href="/api/clouds/888"/>
    <link rel="network" href="/api/networks/RESOURCE_3622956618;2458063335"/>
  </links>
  <name>NAME_22179362</name>
  <description/>
  <resource_uid>RESOURCE_1511444377</resource_uid>
  <created_at>2023/10/09 11:06:02 +0000</created_at>
  <updated_at>2023/10/09 11:06:02 +0000</updated_at>
  <state>available</state>
  <actions/>
  <type>internet</type>
</network_gateway>

MediaTypes:

Resources:

NetworkGateways

Actions

index

Required roles

Parameters

Filters

Example Responses

Click on a format below to see an example response:

show

Required roles

Example Responses

Click on a format below to see an example response:

create

Required roles

Parameters

Example Responses

Click on a format below to see an example response:

update

Required roles

Parameters

Example Responses

Click on a format below to see an example response:

destroy

Required roles

Example Responses

Click on a format below to see an example response: