Cloud Management API 1.5

RouteTables

Grouped listing of Routes

Actions

index

List RouteTables available in this account.

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

Required roles

Parameters

name required type values regexp blank? description
filter no Array * * no See below for valid filter parameters.
view no String default, extended * no Specifies how many attributes and/or expanded nested relationships to include.

Filters

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

Example Responses

Click on a format below to see an example response for the 'default' view:

JSON XML
[{
  "resource_uid": "RESOURCE_1389444894",
  "name": "NAME_2279377121",
  "description": "DESCRIPTION_1252740372",
  "links": [
    {"rel":"self","href":"/api/route_tables/RESOURCE_1389444894;2842505268"},
    {"rel":"cloud","href":"/api/clouds/888"},
    {"rel":"network","href":"/api/networks/RESOURCE_499589352;2833033017"},
    {"rel":"routes","href":"/api/route_tables/RESOURCE_1389444894;2842505268/routes"}
  ],
  "created_at": "2018/10/16 16:04:42 +0000",
  "updated_at": "2018/10/16 16:04:42 +0000"
},{
  "resource_uid": "RESOURCE_3868137211",
  "name": "NAME_895799934",
  "description": "DESCRIPTION_2982416836",
  "links": [
    {"rel":"self","href":"/api/route_tables/RESOURCE_3868137211;3750409678"},
    {"rel":"cloud","href":"/api/clouds/888"},
    {"rel":"network","href":"/api/networks/RESOURCE_3124139332;3089464668"},
    {"rel":"routes","href":"/api/route_tables/RESOURCE_3868137211;3750409678/routes"}
  ],
  "created_at": "2018/10/16 16:04:44 +0000",
  "updated_at": "2018/10/16 16:04:44 +0000"
}]
<?xml version="1.0" encoding="UTF-8"?>
<route_tables>
  <route_table>
    <resource_uid>RESOURCE_1389444894</resource_uid>
    <name>NAME_2279377121</name>
    <description>DESCRIPTION_1252740372</description>
    <links>
      <link rel="self" href="/api/route_tables/RESOURCE_1389444894;2842505268"/>
      <link rel="cloud" href="/api/clouds/888"/>
      <link rel="network" href="/api/networks/RESOURCE_499589352;2833033017"/>
      <link rel="routes" href="/api/route_tables/RESOURCE_1389444894;2842505268/routes"/>
    </links>
    <created_at>2018/10/16 16:04:42 +0000</created_at>
    <updated_at>2018/10/16 16:04:42 +0000</updated_at>
  </route_table>
  <route_table>
    <resource_uid>RESOURCE_3868137211</resource_uid>
    <name>NAME_895799934</name>
    <description>DESCRIPTION_2982416836</description>
    <links>
      <link rel="self" href="/api/route_tables/RESOURCE_3868137211;3750409678"/>
      <link rel="cloud" href="/api/clouds/888"/>
      <link rel="network" href="/api/networks/RESOURCE_3124139332;3089464668"/>
      <link rel="routes" href="/api/route_tables/RESOURCE_3868137211;3750409678/routes"/>
    </links>
    <created_at>2018/10/16 16:04:44 +0000</created_at>
    <updated_at>2018/10/16 16:04:44 +0000</updated_at>
  </route_table>
</route_tables>

Click on a format below to see an example response for the 'extended' view:

JSON XML
[{
  "resource_uid": "RESOURCE_1389444894",
  "name": "NAME_2279377121",
  "description": "DESCRIPTION_1252740372",
  "links": [
    {"rel":"self","href":"/api/route_tables/RESOURCE_1389444894;2842505268"},
    {"rel":"cloud","href":"/api/clouds/888"},
    {"rel":"network","href":"/api/networks/RESOURCE_499589352;2833033017"},
    {"rel":"routes","href":"/api/route_tables/RESOURCE_1389444894;2842505268/routes"}
  ],
  "created_at": "2018/10/16 16:04:42 +0000",
  "updated_at": "2018/10/16 16:04:42 +0000",
  "routes": [
    {
      "description": "DESCRIPTION_1415264661",
      "destination_cidr_block": "10.0.0.0/16",
      "next_hop_type": "instance",
      "state": "available",
      "resource_uid": "RESOURCE_1786056517",
      "created_at": "2018/10/16 16:04:42 +0000",
      "updated_at": "2018/10/16 16:04:42 +0000",
      "links": [
        {"rel":"self","href":"/api/routes/RESOURCE_1786056517;837020603"},
        {"rel":"route_table","href":"/api/route_tables/RESOURCE_1389444894;2842505268"},
        {"rel":"cloud","href":"/api/clouds/888"},
        {"rel":"next_hop","href":"/api/clouds/888/instances/RESOURCE_2308670741;RAND"}
      ],
      "cloud_specific_attributes": null
    }
  ]
},{
  "resource_uid": "RESOURCE_3868137211",
  "name": "NAME_895799934",
  "description": "DESCRIPTION_2982416836",
  "links": [
    {"rel":"self","href":"/api/route_tables/RESOURCE_3868137211;3750409678"},
    {"rel":"cloud","href":"/api/clouds/888"},
    {"rel":"network","href":"/api/networks/RESOURCE_3124139332;3089464668"},
    {"rel":"routes","href":"/api/route_tables/RESOURCE_3868137211;3750409678/routes"}
  ],
  "created_at": "2018/10/16 16:04:44 +0000",
  "updated_at": "2018/10/16 16:04:44 +0000",
  "routes": [
    {
      "description": "DESCRIPTION_1675498754",
      "destination_cidr_block": "10.0.0.0/16",
      "next_hop_type": "instance",
      "state": "available",
      "resource_uid": "RESOURCE_1086215650",
      "created_at": "2018/10/16 16:04:44 +0000",
      "updated_at": "2018/10/16 16:04:44 +0000",
      "links": [
        {"rel":"self","href":"/api/routes/RESOURCE_1086215650;810035809"},
        {"rel":"route_table","href":"/api/route_tables/RESOURCE_3868137211;3750409678"},
        {"rel":"cloud","href":"/api/clouds/888"},
        {"rel":"next_hop","href":"/api/clouds/888/instances/RESOURCE_4070884602;RAND"}
      ],
      "cloud_specific_attributes": null
    }
  ]
}]
<?xml version="1.0" encoding="UTF-8"?>
<route_tables>
  <route_table>
    <resource_uid>RESOURCE_1389444894</resource_uid>
    <name>NAME_2279377121</name>
    <description>DESCRIPTION_1252740372</description>
    <links>
      <link rel="self" href="/api/route_tables/RESOURCE_1389444894;2842505268"/>
      <link rel="cloud" href="/api/clouds/888"/>
      <link rel="network" href="/api/networks/RESOURCE_499589352;2833033017"/>
      <link rel="routes" href="/api/route_tables/RESOURCE_1389444894;2842505268/routes"/>
    </links>
    <created_at>2018/10/16 16:04:42 +0000</created_at>
    <updated_at>2018/10/16 16:04:42 +0000</updated_at>
    <routes>
      <route>
        <description>DESCRIPTION_1415264661</description>
        <destination_cidr_block>10.0.0.0/16</destination_cidr_block>
        <next_hop_type>instance</next_hop_type>
        <state>available</state>
        <resource_uid>RESOURCE_1786056517</resource_uid>
        <created_at>2018/10/16 16:04:42 +0000</created_at>
        <updated_at>2018/10/16 16:04:42 +0000</updated_at>
        <links>
          <link rel="self" href="/api/routes/RESOURCE_1786056517;837020603"/>
          <link rel="route_table" href="/api/route_tables/RESOURCE_1389444894;2842505268"/>
          <link rel="cloud" href="/api/clouds/888"/>
          <link rel="next_hop" href="/api/clouds/888/instances/RESOURCE_2308670741;RAND"/>
        </links>
        <cloud_specific_attributes/>
      </route>
    </routes>
  </route_table>
  <route_table>
    <resource_uid>RESOURCE_3868137211</resource_uid>
    <name>NAME_895799934</name>
    <description>DESCRIPTION_2982416836</description>
    <links>
      <link rel="self" href="/api/route_tables/RESOURCE_3868137211;3750409678"/>
      <link rel="cloud" href="/api/clouds/888"/>
      <link rel="network" href="/api/networks/RESOURCE_3124139332;3089464668"/>
      <link rel="routes" href="/api/route_tables/RESOURCE_3868137211;3750409678/routes"/>
    </links>
    <created_at>2018/10/16 16:04:44 +0000</created_at>
    <updated_at>2018/10/16 16:04:44 +0000</updated_at>
    <routes>
      <route>
        <description>DESCRIPTION_1675498754</description>
        <destination_cidr_block>10.0.0.0/16</destination_cidr_block>
        <next_hop_type>instance</next_hop_type>
        <state>available</state>
        <resource_uid>RESOURCE_1086215650</resource_uid>
        <created_at>2018/10/16 16:04:44 +0000</created_at>
        <updated_at>2018/10/16 16:04:44 +0000</updated_at>
        <links>
          <link rel="self" href="/api/routes/RESOURCE_1086215650;810035809"/>
          <link rel="route_table" href="/api/route_tables/RESOURCE_3868137211;3750409678"/>
          <link rel="cloud" href="/api/clouds/888"/>
          <link rel="next_hop" href="/api/clouds/888/instances/RESOURCE_4070884602;RAND"/>
        </links>
        <cloud_specific_attributes/>
      </route>
    </routes>
  </route_table>
</route_tables>

show

Show information about a single RouteTable.

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

Required roles

Parameters

name required type values regexp blank? description
view no String default, extended * no Specifies how many attributes and/or expanded nested relationships to include.

Example Responses

Click on a format below to see an example response for the 'default' view:

JSON XML
{
  "resource_uid": "RESOURCE_1389444894",
  "name": "NAME_2279377121",
  "description": "DESCRIPTION_1252740372",
  "links": [
    {"rel":"self","href":"/api/route_tables/RESOURCE_1389444894;2842505268"},
    {"rel":"cloud","href":"/api/clouds/888"},
    {"rel":"network","href":"/api/networks/RESOURCE_499589352;2833033017"},
    {"rel":"routes","href":"/api/route_tables/RESOURCE_1389444894;2842505268/routes"}
  ],
  "created_at": "2018/10/16 16:04:42 +0000",
  "updated_at": "2018/10/16 16:04:42 +0000"
}
<?xml version="1.0" encoding="UTF-8"?>
<route_table>
  <resource_uid>RESOURCE_1389444894</resource_uid>
  <name>NAME_2279377121</name>
  <description>DESCRIPTION_1252740372</description>
  <links>
    <link rel="self" href="/api/route_tables/RESOURCE_1389444894;2842505268"/>
    <link rel="cloud" href="/api/clouds/888"/>
    <link rel="network" href="/api/networks/RESOURCE_499589352;2833033017"/>
    <link rel="routes" href="/api/route_tables/RESOURCE_1389444894;2842505268/routes"/>
  </links>
  <created_at>2018/10/16 16:04:42 +0000</created_at>
  <updated_at>2018/10/16 16:04:42 +0000</updated_at>
</route_table>

Click on a format below to see an example response for the 'extended' view:

JSON XML
{
  "resource_uid": "RESOURCE_1389444894",
  "name": "NAME_2279377121",
  "description": "DESCRIPTION_1252740372",
  "links": [
    {"rel":"self","href":"/api/route_tables/RESOURCE_1389444894;2842505268"},
    {"rel":"cloud","href":"/api/clouds/888"},
    {"rel":"network","href":"/api/networks/RESOURCE_499589352;2833033017"},
    {"rel":"routes","href":"/api/route_tables/RESOURCE_1389444894;2842505268/routes"}
  ],
  "created_at": "2018/10/16 16:04:42 +0000",
  "updated_at": "2018/10/16 16:04:42 +0000",
  "routes": [
    {
      "description": "DESCRIPTION_1415264661",
      "destination_cidr_block": "10.0.0.0/16",
      "next_hop_type": "instance",
      "state": "available",
      "resource_uid": "RESOURCE_1786056517",
      "created_at": "2018/10/16 16:04:42 +0000",
      "updated_at": "2018/10/16 16:04:42 +0000",
      "links": [
        {"rel":"self","href":"/api/routes/RESOURCE_1786056517;837020603"},
        {"rel":"route_table","href":"/api/route_tables/RESOURCE_1389444894;2842505268"},
        {"rel":"cloud","href":"/api/clouds/888"},
        {"rel":"next_hop","href":"/api/clouds/888/instances/RESOURCE_2308670741;RAND"}
      ],
      "cloud_specific_attributes": null
    }
  ]
}
<?xml version="1.0" encoding="UTF-8"?>
<route_table>
  <resource_uid>RESOURCE_1389444894</resource_uid>
  <name>NAME_2279377121</name>
  <description>DESCRIPTION_1252740372</description>
  <links>
    <link rel="self" href="/api/route_tables/RESOURCE_1389444894;2842505268"/>
    <link rel="cloud" href="/api/clouds/888"/>
    <link rel="network" href="/api/networks/RESOURCE_499589352;2833033017"/>
    <link rel="routes" href="/api/route_tables/RESOURCE_1389444894;2842505268/routes"/>
  </links>
  <created_at>2018/10/16 16:04:42 +0000</created_at>
  <updated_at>2018/10/16 16:04:42 +0000</updated_at>
  <routes>
    <route>
      <description>DESCRIPTION_1415264661</description>
      <destination_cidr_block>10.0.0.0/16</destination_cidr_block>
      <next_hop_type>instance</next_hop_type>
      <state>available</state>
      <resource_uid>RESOURCE_1786056517</resource_uid>
      <created_at>2018/10/16 16:04:42 +0000</created_at>
      <updated_at>2018/10/16 16:04:42 +0000</updated_at>
      <links>
        <link rel="self" href="/api/routes/RESOURCE_1786056517;837020603"/>
        <link rel="route_table" href="/api/route_tables/RESOURCE_1389444894;2842505268"/>
        <link rel="cloud" href="/api/clouds/888"/>
        <link rel="next_hop" href="/api/clouds/888/instances/RESOURCE_2308670741;RAND"/>
      </links>
      <cloud_specific_attributes/>
    </route>
  </routes>
</route_table>

create

Create a new RouteTable.

URLs
POST /api/route_tables
HTTP response code
201 Created

Required roles

Parameters

name required type values regexp blank? description
route_table yes Hash * * no
route_table[cloud_href] yes String * * no The cloud to create the RouteTable in.
route_table[description] no String * * yes The description to be set on the RouteTable.
route_table[name] yes String * * yes The name to be set on the RouteTable.
route_table[network_href] yes String * * no The Network to create the RouteTable in.

update

Update an existing RouteTable.

URLs
PUT /api/route_tables/:id
HTTP response code
204 No Content

Required roles

Parameters

name required type values regexp blank? description
route_table yes Hash * * no
route_table[description] no String * * yes The description to be set on the RouteTable.
route_table[name] no String * * yes The name to be set on the RouteTable.

destroy

Delete an existing RouteTable.

URLs
DELETE /api/route_tables/:id
HTTP response code
204 No Content

Required roles