Cloud Management API 1.5
IpAddresses
An IpAddress provides an abstraction for IPv4 addresses bindable to Instance resources running in a Cloud.
Actions
index
Lists the IpAddresses available to this account.
- URLs
- GET /api/clouds/:cloud_id/ip_addresses
- HTTP response code
- 200 OK
- Content-type
- application/vnd.rightscale.ip_address;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 |
|---|---|---|
| deployment_href | no | Deployment href to filter on. |
| name | yes | Name of the IpAddress to filter on. |
Example Responses
Click on a format below to see an example response:
JSON XML[{
"created_at": "2023/10/09 11:06:01 +0000",
"updated_at": "2023/10/09 11:06:01 +0000",
"name": "NAME_2855482703",
"links": [
{"rel":"self","href":"/api/clouds/888/ip_addresses/RESOURCE_881330044;RAND"},
{"rel":"ip_address_bindings","href":"/api/clouds/888/ip_addresses/RESOURCE_881330044;RAND/ip_address_bindings"}
],
"address": "127.0.0.1"
},{
"created_at": "2023/10/09 11:06:03 +0000",
"updated_at": "2023/10/09 11:06:03 +0000",
"name": "NAME_1364081790",
"links": [
{"rel":"self","href":"/api/clouds/888/ip_addresses/RESOURCE_3438004964;RAND"},
{"rel":"ip_address_bindings","href":"/api/clouds/888/ip_addresses/RESOURCE_3438004964;RAND/ip_address_bindings"}
],
"address": "127.0.0.1"
}]<?xml version="1.0" encoding="UTF-8"?>
<ip_addresses>
<ip_address>
<created_at>2023/10/09 11:06:01 +0000</created_at>
<updated_at>2023/10/09 11:06:01 +0000</updated_at>
<name>NAME_2855482703</name>
<links>
<link rel="self" href="/api/clouds/888/ip_addresses/RESOURCE_881330044;RAND"/>
<link rel="ip_address_bindings" href="/api/clouds/888/ip_addresses/RESOURCE_881330044;RAND/ip_address_bindings"/>
</links>
<address>127.0.0.1</address>
</ip_address>
<ip_address>
<created_at>2023/10/09 11:06:03 +0000</created_at>
<updated_at>2023/10/09 11:06:03 +0000</updated_at>
<name>NAME_1364081790</name>
<links>
<link rel="self" href="/api/clouds/888/ip_addresses/RESOURCE_3438004964;RAND"/>
<link rel="ip_address_bindings" href="/api/clouds/888/ip_addresses/RESOURCE_3438004964;RAND/ip_address_bindings"/>
</links>
<address>127.0.0.1</address>
</ip_address>
</ip_addresses>
show
Show information about a single IpAddress.
- URLs
- GET /api/clouds/:cloud_id/ip_addresses/:id
- HTTP response code
- 200 OK
- Content-type
- application/vnd.rightscale.ip_address
Required roles
- observer
Example Responses
Click on a format below to see an example response:
JSON XML{
"created_at": "2023/10/09 11:06:01 +0000",
"updated_at": "2023/10/09 11:06:01 +0000",
"name": "NAME_2855482703",
"links": [
{"rel":"self","href":"/api/clouds/888/ip_addresses/RESOURCE_881330044;RAND"},
{"rel":"ip_address_bindings","href":"/api/clouds/888/ip_addresses/RESOURCE_881330044;RAND/ip_address_bindings"}
],
"address": "127.0.0.1"
}<?xml version="1.0" encoding="UTF-8"?>
<ip_address>
<created_at>2023/10/09 11:06:01 +0000</created_at>
<updated_at>2023/10/09 11:06:01 +0000</updated_at>
<name>NAME_2855482703</name>
<links>
<link rel="self" href="/api/clouds/888/ip_addresses/RESOURCE_881330044;RAND"/>
<link rel="ip_address_bindings" href="/api/clouds/888/ip_addresses/RESOURCE_881330044;RAND/ip_address_bindings"/>
</links>
<address>127.0.0.1</address>
</ip_address>
create
Creates a new IpAddress with the given parameters.
- URLs
- POST /api/clouds/:cloud_id/ip_addresses
- HTTP response code
- 201 Created
- Location
- Href of the created IpAddress.
Required roles
- actor
Parameters
| name | required | type | values | regexp | blank? | description |
|---|---|---|---|---|---|---|
| ip_address | yes | Hash | * | * | no | |
| ip_address[deployment_href] | no | String | * | * | no | The href of the Deployment that owns this IpAddress. |
| ip_address[domain] | no | String | ec2_classic, vpc | * | no | (Amazon Only) Pass vpc to create this IP for EC2-VPC only environments. Pass ec2_classic to create this IP for EC2-Classic environments. Defaults to ec2_classic. |
| ip_address[name] | yes | String | * | * | no | The name of the IpAddress to be created. |
| ip_address[network_href] | no | String | * | * | no | (OpenStack Only) The href of the Network that the IpAddress will be associated to. This parameter is required for OpenStack with Neutron clouds. |
update
Updates attributes of a given IpAddress.
- URLs
- PUT /api/clouds/:cloud_id/ip_addresses/:id
- HTTP response code
- 204 No Content
Required roles
- actor
Parameters
| name | required | type | values | regexp | blank? | description |
|---|---|---|---|---|---|---|
| ip_address | yes | Hash | * | * | no | |
| ip_address[deployment_href] | no | String | * | * | no | The href of the Deployment that owns this IpAddress. |
| ip_address[name] | yes | String | * | * | no | The updated name of the IpAddress. |
destroy
Deletes a given IpAddress.
- URLs
- DELETE /api/clouds/:cloud_id/ip_addresses/:id
- HTTP response code
- 204 No Content
Required roles
- actor