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
- observer
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_3446838169",
"name": "NAME_2341720847",
"description": "DESCRIPTION_1304180881",
"links": [
{"rel":"self","href":"/api/route_tables/RESOURCE_3446838169;668428100"},
{"rel":"cloud","href":"/api/clouds/888"},
{"rel":"network","href":"/api/networks/RESOURCE_1164412747;268981889"},
{"rel":"routes","href":"/api/route_tables/RESOURCE_3446838169;668428100/routes"}
],
"created_at": "2023/10/09 11:06:02 +0000",
"updated_at": "2023/10/09 11:06:02 +0000"
},{
"resource_uid": "RESOURCE_1438581546",
"name": "NAME_4257684049",
"description": "DESCRIPTION_2327457609",
"links": [
{"rel":"self","href":"/api/route_tables/RESOURCE_1438581546;1014880811"},
{"rel":"cloud","href":"/api/clouds/888"},
{"rel":"network","href":"/api/networks/RESOURCE_699566851;2110264605"},
{"rel":"routes","href":"/api/route_tables/RESOURCE_1438581546;1014880811/routes"}
],
"created_at": "2023/10/09 11:06:03 +0000",
"updated_at": "2023/10/09 11:06:03 +0000"
}]<?xml version="1.0" encoding="UTF-8"?>
<route_tables>
<route_table>
<resource_uid>RESOURCE_3446838169</resource_uid>
<name>NAME_2341720847</name>
<description>DESCRIPTION_1304180881</description>
<links>
<link rel="self" href="/api/route_tables/RESOURCE_3446838169;668428100"/>
<link rel="cloud" href="/api/clouds/888"/>
<link rel="network" href="/api/networks/RESOURCE_1164412747;268981889"/>
<link rel="routes" href="/api/route_tables/RESOURCE_3446838169;668428100/routes"/>
</links>
<created_at>2023/10/09 11:06:02 +0000</created_at>
<updated_at>2023/10/09 11:06:02 +0000</updated_at>
</route_table>
<route_table>
<resource_uid>RESOURCE_1438581546</resource_uid>
<name>NAME_4257684049</name>
<description>DESCRIPTION_2327457609</description>
<links>
<link rel="self" href="/api/route_tables/RESOURCE_1438581546;1014880811"/>
<link rel="cloud" href="/api/clouds/888"/>
<link rel="network" href="/api/networks/RESOURCE_699566851;2110264605"/>
<link rel="routes" href="/api/route_tables/RESOURCE_1438581546;1014880811/routes"/>
</links>
<created_at>2023/10/09 11:06:03 +0000</created_at>
<updated_at>2023/10/09 11:06:03 +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_3446838169",
"name": "NAME_2341720847",
"description": "DESCRIPTION_1304180881",
"links": [
{"rel":"self","href":"/api/route_tables/RESOURCE_3446838169;668428100"},
{"rel":"cloud","href":"/api/clouds/888"},
{"rel":"network","href":"/api/networks/RESOURCE_1164412747;268981889"},
{"rel":"routes","href":"/api/route_tables/RESOURCE_3446838169;668428100/routes"}
],
"created_at": "2023/10/09 11:06:02 +0000",
"updated_at": "2023/10/09 11:06:02 +0000",
"routes": [
{
"description": "DESCRIPTION_1583034156",
"destination_cidr_block": "10.0.0.0/16",
"next_hop_type": "instance",
"state": "available",
"resource_uid": "RESOURCE_2409062953",
"created_at": "2023/10/09 11:06:02 +0000",
"updated_at": "2023/10/09 11:06:02 +0000",
"links": [
{"rel":"self","href":"/api/routes/RESOURCE_2409062953;4279184931"},
{"rel":"route_table","href":"/api/route_tables/RESOURCE_3446838169;668428100"},
{"rel":"cloud","href":"/api/clouds/888"},
{"rel":"next_hop","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND"}
],
"cloud_specific_attributes": null
}
]
},{
"resource_uid": "RESOURCE_1438581546",
"name": "NAME_4257684049",
"description": "DESCRIPTION_2327457609",
"links": [
{"rel":"self","href":"/api/route_tables/RESOURCE_1438581546;1014880811"},
{"rel":"cloud","href":"/api/clouds/888"},
{"rel":"network","href":"/api/networks/RESOURCE_699566851;2110264605"},
{"rel":"routes","href":"/api/route_tables/RESOURCE_1438581546;1014880811/routes"}
],
"created_at": "2023/10/09 11:06:03 +0000",
"updated_at": "2023/10/09 11:06:03 +0000",
"routes": [
{
"description": "DESCRIPTION_3200592931",
"destination_cidr_block": "10.0.0.0/16",
"next_hop_type": "instance",
"state": "available",
"resource_uid": "RESOURCE_849474362",
"created_at": "2023/10/09 11:06:03 +0000",
"updated_at": "2023/10/09 11:06:03 +0000",
"links": [
{"rel":"self","href":"/api/routes/RESOURCE_849474362;309766669"},
{"rel":"route_table","href":"/api/route_tables/RESOURCE_1438581546;1014880811"},
{"rel":"cloud","href":"/api/clouds/888"},
{"rel":"next_hop","href":"/api/clouds/888/instances/RESOURCE_1620899759;RAND"}
],
"cloud_specific_attributes": null
}
]
}]<?xml version="1.0" encoding="UTF-8"?>
<route_tables>
<route_table>
<resource_uid>RESOURCE_3446838169</resource_uid>
<name>NAME_2341720847</name>
<description>DESCRIPTION_1304180881</description>
<links>
<link rel="self" href="/api/route_tables/RESOURCE_3446838169;668428100"/>
<link rel="cloud" href="/api/clouds/888"/>
<link rel="network" href="/api/networks/RESOURCE_1164412747;268981889"/>
<link rel="routes" href="/api/route_tables/RESOURCE_3446838169;668428100/routes"/>
</links>
<created_at>2023/10/09 11:06:02 +0000</created_at>
<updated_at>2023/10/09 11:06:02 +0000</updated_at>
<routes>
<route>
<description>DESCRIPTION_1583034156</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_2409062953</resource_uid>
<created_at>2023/10/09 11:06:02 +0000</created_at>
<updated_at>2023/10/09 11:06:02 +0000</updated_at>
<links>
<link rel="self" href="/api/routes/RESOURCE_2409062953;4279184931"/>
<link rel="route_table" href="/api/route_tables/RESOURCE_3446838169;668428100"/>
<link rel="cloud" href="/api/clouds/888"/>
<link rel="next_hop" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND"/>
</links>
<cloud_specific_attributes/>
</route>
</routes>
</route_table>
<route_table>
<resource_uid>RESOURCE_1438581546</resource_uid>
<name>NAME_4257684049</name>
<description>DESCRIPTION_2327457609</description>
<links>
<link rel="self" href="/api/route_tables/RESOURCE_1438581546;1014880811"/>
<link rel="cloud" href="/api/clouds/888"/>
<link rel="network" href="/api/networks/RESOURCE_699566851;2110264605"/>
<link rel="routes" href="/api/route_tables/RESOURCE_1438581546;1014880811/routes"/>
</links>
<created_at>2023/10/09 11:06:03 +0000</created_at>
<updated_at>2023/10/09 11:06:03 +0000</updated_at>
<routes>
<route>
<description>DESCRIPTION_3200592931</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_849474362</resource_uid>
<created_at>2023/10/09 11:06:03 +0000</created_at>
<updated_at>2023/10/09 11:06:03 +0000</updated_at>
<links>
<link rel="self" href="/api/routes/RESOURCE_849474362;309766669"/>
<link rel="route_table" href="/api/route_tables/RESOURCE_1438581546;1014880811"/>
<link rel="cloud" href="/api/clouds/888"/>
<link rel="next_hop" href="/api/clouds/888/instances/RESOURCE_1620899759;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
- observer
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_3446838169",
"name": "NAME_2341720847",
"description": "DESCRIPTION_1304180881",
"links": [
{"rel":"self","href":"/api/route_tables/RESOURCE_3446838169;668428100"},
{"rel":"cloud","href":"/api/clouds/888"},
{"rel":"network","href":"/api/networks/RESOURCE_1164412747;268981889"},
{"rel":"routes","href":"/api/route_tables/RESOURCE_3446838169;668428100/routes"}
],
"created_at": "2023/10/09 11:06:02 +0000",
"updated_at": "2023/10/09 11:06:02 +0000"
}<?xml version="1.0" encoding="UTF-8"?>
<route_table>
<resource_uid>RESOURCE_3446838169</resource_uid>
<name>NAME_2341720847</name>
<description>DESCRIPTION_1304180881</description>
<links>
<link rel="self" href="/api/route_tables/RESOURCE_3446838169;668428100"/>
<link rel="cloud" href="/api/clouds/888"/>
<link rel="network" href="/api/networks/RESOURCE_1164412747;268981889"/>
<link rel="routes" href="/api/route_tables/RESOURCE_3446838169;668428100/routes"/>
</links>
<created_at>2023/10/09 11:06:02 +0000</created_at>
<updated_at>2023/10/09 11:06:02 +0000</updated_at>
</route_table>
Click on a format below to see an example response for the 'extended' view:
JSON XML{
"resource_uid": "RESOURCE_3446838169",
"name": "NAME_2341720847",
"description": "DESCRIPTION_1304180881",
"links": [
{"rel":"self","href":"/api/route_tables/RESOURCE_3446838169;668428100"},
{"rel":"cloud","href":"/api/clouds/888"},
{"rel":"network","href":"/api/networks/RESOURCE_1164412747;268981889"},
{"rel":"routes","href":"/api/route_tables/RESOURCE_3446838169;668428100/routes"}
],
"created_at": "2023/10/09 11:06:02 +0000",
"updated_at": "2023/10/09 11:06:02 +0000",
"routes": [
{
"description": "DESCRIPTION_1583034156",
"destination_cidr_block": "10.0.0.0/16",
"next_hop_type": "instance",
"state": "available",
"resource_uid": "RESOURCE_2409062953",
"created_at": "2023/10/09 11:06:02 +0000",
"updated_at": "2023/10/09 11:06:02 +0000",
"links": [
{"rel":"self","href":"/api/routes/RESOURCE_2409062953;4279184931"},
{"rel":"route_table","href":"/api/route_tables/RESOURCE_3446838169;668428100"},
{"rel":"cloud","href":"/api/clouds/888"},
{"rel":"next_hop","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND"}
],
"cloud_specific_attributes": null
}
]
}<?xml version="1.0" encoding="UTF-8"?>
<route_table>
<resource_uid>RESOURCE_3446838169</resource_uid>
<name>NAME_2341720847</name>
<description>DESCRIPTION_1304180881</description>
<links>
<link rel="self" href="/api/route_tables/RESOURCE_3446838169;668428100"/>
<link rel="cloud" href="/api/clouds/888"/>
<link rel="network" href="/api/networks/RESOURCE_1164412747;268981889"/>
<link rel="routes" href="/api/route_tables/RESOURCE_3446838169;668428100/routes"/>
</links>
<created_at>2023/10/09 11:06:02 +0000</created_at>
<updated_at>2023/10/09 11:06:02 +0000</updated_at>
<routes>
<route>
<description>DESCRIPTION_1583034156</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_2409062953</resource_uid>
<created_at>2023/10/09 11:06:02 +0000</created_at>
<updated_at>2023/10/09 11:06:02 +0000</updated_at>
<links>
<link rel="self" href="/api/routes/RESOURCE_2409062953;4279184931"/>
<link rel="route_table" href="/api/route_tables/RESOURCE_3446838169;668428100"/>
<link rel="cloud" href="/api/clouds/888"/>
<link rel="next_hop" href="/api/clouds/888/instances/RESOURCE_2014175382;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
- security_manager
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
- security_manager
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
- security_manager