Cloud Management API 1.5
ResourceGroups
Actions
index
Lists all ResourceGroups in an account.
- URLs
- GET /api/resource_groups
- HTTP response code
- 200 OK
- Content-type
- application/vnd.rightscale.resource_group;type=collection
Required roles
- observer||instance
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 | Href of the Cloud to filter on. |
| name | yes | Name of the Resource Groups to filter on. |
| state | no | State of the Resource Groups to filter on. Valid values are: ["available", "unavalable"]. |
show
Shows information about a single ResourceGroup.
- URLs
- GET /api/resource_groups/:id
- HTTP response code
- 200 OK
- Content-type
- application/vnd.rightscale.resource_group
Required roles
- observer||instance
create
Creates a ResourceGroup.
- URLs
- POST /api/resource_groups
- HTTP response code
- 201 Created
Required roles
- actor
Parameters
| name | required | type | values | regexp | blank? | description |
|---|---|---|---|---|---|---|
| resource_group | yes | Hash | * | * | no | |
| resource_group[cloud_href] | yes | String | * | * | no | The Href of the Cloud in which the ResourceGroup should be created. |
| resource_group[deployment_href] | no | String | * | * | no | The Href of the Deployment that owns this Resource Group. |
| resource_group[description] | no | String | * | * | yes | The description of the Resource Group to be created. |
| resource_group[name] | yes | String | * | * | no | The name of the Resource Group to be created. |
update
Updates attributes of a given ResourceGroup.
- URLs
- PUT /api/resource_groups/:id
- HTTP response code
- 204 No Content
Required roles
- actor
Parameters
| name | required | type | values | regexp | blank? | description |
|---|---|---|---|---|---|---|
| resource_group | yes | Hash | * | * | no | |
| resource_group[deployment_href] | no | String | * | * | no | The Href of the Deployment that owns this Resource Group. |
| resource_group[description] | no | String | * | * | yes | The description of the Resource Group to be created. |
destroy
Destroys a ResourceGroup.
- URLs
- DELETE /api/resource_groups/:id
- HTTP response code
- 204 No Content
Required roles
- actor