Cloud Management API 1.5
Networks
A Network is a logical grouping of network devices.
Actions
index
Lists networks in this account.
- URLs
- GET /api/networks
- HTTP response code
- 200 OK
- Content-type
- application/vnd.rightscale.network;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 |
|---|---|---|
| cidr_block | no | Network's CIDR to filter on. |
| cloud_href | no | Cloud href to filter on. |
| deployment_href | no | Deployment href to filter on. |
| name | yes | Name of the Network to filter on. |
| resource_uid | no | Resource Unique Identifier for the Network to filter on. |
Example Responses
Click on a format below to see an example response:
JSON XML[{
"resource_uid": "RESOURCE_1164412747",
"name": "NAME_733274954",
"description": "DESCRIPTION_4192739876",
"instance_tenancy": "INSTANCE_TENANCY_1001117077",
"cidr_block": "10.0.0.0/32",
"is_default": false,
"links": [
{"rel":"self","href":"/api/networks/RESOURCE_1164412747;268981889"},
{"rel":"cloud","href":"/api/clouds/888"}
]
},{
"resource_uid": "RESOURCE_699566851",
"name": "NAME_1931434849",
"description": "DESCRIPTION_220635549",
"instance_tenancy": "INSTANCE_TENANCY_3716717088",
"cidr_block": "10.0.0.0/32",
"is_default": false,
"links": [
{"rel":"self","href":"/api/networks/RESOURCE_699566851;2110264605"},
{"rel":"cloud","href":"/api/clouds/888"}
]
}]<?xml version="1.0" encoding="UTF-8"?>
<networks>
<network>
<resource_uid>RESOURCE_1164412747</resource_uid>
<name>NAME_733274954</name>
<description>DESCRIPTION_4192739876</description>
<instance_tenancy>INSTANCE_TENANCY_1001117077</instance_tenancy>
<cidr_block>10.0.0.0/32</cidr_block>
<is_default>false</is_default>
<links>
<link rel="self" href="/api/networks/RESOURCE_1164412747;268981889"/>
<link rel="cloud" href="/api/clouds/888"/>
</links>
</network>
<network>
<resource_uid>RESOURCE_699566851</resource_uid>
<name>NAME_1931434849</name>
<description>DESCRIPTION_220635549</description>
<instance_tenancy>INSTANCE_TENANCY_3716717088</instance_tenancy>
<cidr_block>10.0.0.0/32</cidr_block>
<is_default>false</is_default>
<links>
<link rel="self" href="/api/networks/RESOURCE_699566851;2110264605"/>
<link rel="cloud" href="/api/clouds/888"/>
</links>
</network>
</networks>
show
Shows attributes of a single network.
- URLs
- GET /api/networks/:id
- HTTP response code
- 200 OK
- Content-type
- application/vnd.rightscale.network
Required roles
- observer
Example Responses
Click on a format below to see an example response:
JSON XML{
"resource_uid": "RESOURCE_1164412747",
"name": "NAME_733274954",
"description": "DESCRIPTION_4192739876",
"instance_tenancy": "INSTANCE_TENANCY_1001117077",
"cidr_block": "10.0.0.0/32",
"is_default": false,
"links": [
{"rel":"self","href":"/api/networks/RESOURCE_1164412747;268981889"},
{"rel":"cloud","href":"/api/clouds/888"}
]
}<?xml version="1.0" encoding="UTF-8"?>
<network>
<resource_uid>RESOURCE_1164412747</resource_uid>
<name>NAME_733274954</name>
<description>DESCRIPTION_4192739876</description>
<instance_tenancy>INSTANCE_TENANCY_1001117077</instance_tenancy>
<cidr_block>10.0.0.0/32</cidr_block>
<is_default>false</is_default>
<links>
<link rel="self" href="/api/networks/RESOURCE_1164412747;268981889"/>
<link rel="cloud" href="/api/clouds/888"/>
</links>
</network>
create
Creates a new network.
- URLs
- POST /api/networks
- HTTP response code
- 201 Created
Required roles
- security_manager
Parameters
| name | required | type | values | regexp | blank? | description |
|---|---|---|---|---|---|---|
| network | yes | Hash | * | * | no | |
| network[cidr_block] | no | String | * | * | no | The range of IP addresses for the Network. This parameter is required for Amazon clouds. |
| network[cloud_href] | yes | String | * | * | no | The Cloud to create the Network in |
| network[deployment_href] | no | String | * | * | no | The href of the Deployment that owns this Network. |
| network[description] | no | String | * | * | no | The description for the Network. |
| network[instance_tenancy] | no | String | * | * | no | The launch policy for AWS instances in the Network. Specify 'default' to allow instances to decide their own launch policy. Specify 'dedicated' to force all instances to be launched as 'dedicated'. |
| network[name] | no | String | * | * | no | The name for the Network. |
update
Updates the given network.
- URLs
- PUT /api/networks/:id
- HTTP response code
- 204 No Content
Required roles
- security_manager
Parameters
| name | required | type | values | regexp | blank? | description |
|---|---|---|---|---|---|---|
| network | yes | Hash | * | * | no | |
| network[deployment_href] | no | String | * | * | no | The href of the Deployment that owns this Network. |
| network[description] | no | String | * | * | no | The updated description for the Network. |
| network[name] | no | String | * | * | no | The updated name for the Network. |
| network[route_table_href] | no | String | * | * | no | Sets the default RouteTable for this Network. |
destroy
Deletes the given network(s).
- URLs
- DELETE /api/networks/:id
- HTTP response code
- 204 No Content
Required roles
- security_manager