Cloud Management API 1.5
ServerTemplateMultiCloudImages
This resource represents links between ServerTemplates and MultiCloud Images and enables you to effectively add/delete MultiCloudImages to ServerTemplates and make them the default one.
Actions
index
Lists the ServerTemplateMultiCloudImages available to this account.
- URLs
- GET /api/server_template_multi_cloud_images
- HTTP response code
- 200 OK
- Content-type
- application/vnd.rightscale.server_template_multi_cloud_image;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 | * | no | Specifies how many attributes and/or expanded nested relationships to include. |
Filters
| name | partial_match? | description |
|---|---|---|
| is_default | no | The is_default attribute of the ServerTemplateMultiCloudImage to filter on. The value passed must be either 1 (true) or 0 (false). |
| multi_cloud_image_href | no | The href of the MultiCloud Image to filter on. |
| server_template_href | no | The href of the ServerTemplate to filter on. |
Example Responses
Click on a format below to see an example response:
JSON XML[{
"created_at": "2023/10/09 11:06:00 +0000",
"updated_at": "2023/10/09 11:06:00 +0000",
"is_default": true,
"links": [
{"rel":"self","href":"/api/server_template_multi_cloud_images/1"},
{"rel":"server_template","href":"/api/server_templates/1"},
{"rel":"multi_cloud_image","href":"/api/multi_cloud_images/1"}
],
"actions": [
]
},{
"created_at": "2023/10/09 11:06:02 +0000",
"updated_at": "2023/10/09 11:06:02 +0000",
"is_default": true,
"links": [
{"rel":"self","href":"/api/server_template_multi_cloud_images/2"},
{"rel":"server_template","href":"/api/server_templates/5"},
{"rel":"multi_cloud_image","href":"/api/multi_cloud_images/2"}
],
"actions": [
]
}]<?xml version="1.0" encoding="UTF-8"?>
<server_template_multi_cloud_images>
<server_template_multi_cloud_image>
<created_at>2023/10/09 11:06:00 +0000</created_at>
<updated_at>2023/10/09 11:06:00 +0000</updated_at>
<is_default>true</is_default>
<links>
<link rel="self" href="/api/server_template_multi_cloud_images/1"/>
<link rel="server_template" href="/api/server_templates/1"/>
<link rel="multi_cloud_image" href="/api/multi_cloud_images/1"/>
</links>
<actions/>
</server_template_multi_cloud_image>
<server_template_multi_cloud_image>
<created_at>2023/10/09 11:06:02 +0000</created_at>
<updated_at>2023/10/09 11:06:02 +0000</updated_at>
<is_default>true</is_default>
<links>
<link rel="self" href="/api/server_template_multi_cloud_images/2"/>
<link rel="server_template" href="/api/server_templates/5"/>
<link rel="multi_cloud_image" href="/api/multi_cloud_images/2"/>
</links>
<actions/>
</server_template_multi_cloud_image>
</server_template_multi_cloud_images>
show
Show information about a single ServerTemplateMultiCloudImage which represents an association between a ServerTemplate and a MultiCloudImage.
- URLs
- GET /api/server_template_multi_cloud_images/:id
- HTTP response code
- 200 OK
- Content-type
- application/vnd.rightscale.server_template_multi_cloud_image
Required roles
- observer
Parameters
| name | required | type | values | regexp | blank? | description |
|---|---|---|---|---|---|---|
| view | no | String | default | * | no | Specifies how many attributes and/or expanded nested relationships to include. |
Example Responses
Click on a format below to see an example response:
JSON XML{
"created_at": "2023/10/09 11:06:00 +0000",
"updated_at": "2023/10/09 11:06:00 +0000",
"is_default": true,
"links": [
{"rel":"self","href":"/api/server_template_multi_cloud_images/1"},
{"rel":"server_template","href":"/api/server_templates/1"},
{"rel":"multi_cloud_image","href":"/api/multi_cloud_images/1"}
],
"actions": [
]
}<?xml version="1.0" encoding="UTF-8"?>
<server_template_multi_cloud_image>
<created_at>2023/10/09 11:06:00 +0000</created_at>
<updated_at>2023/10/09 11:06:00 +0000</updated_at>
<is_default>true</is_default>
<links>
<link rel="self" href="/api/server_template_multi_cloud_images/1"/>
<link rel="server_template" href="/api/server_templates/1"/>
<link rel="multi_cloud_image" href="/api/multi_cloud_images/1"/>
</links>
<actions/>
</server_template_multi_cloud_image>
create
Creates a new ServerTemplateMultiCloudImage with the given parameters.
- URLs
- POST /api/server_template_multi_cloud_images
- HTTP response code
- 201 Created
- Location
- Href of the created ServerTemplateMultiCloudImage.
Required roles
- designer
Parameters
| name | required | type | values | regexp | blank? | description |
|---|---|---|---|---|---|---|
| server_template_multi_cloud_image | yes | Hash | * | * | no | |
| server_template_multi_cloud_image[multi_cloud_image_href] | yes | String | * | * | no | The href of the MultiCloud Image to be used. |
| server_template_multi_cloud_image[server_template_href] | yes | String | * | * | no | The href of the ServerTemplate to be used. |
destroy
Deletes a given ServerTemplateMultiCloudImage.
- URLs
- DELETE /api/server_template_multi_cloud_images/:id
- HTTP response code
- 204 No Content
Required roles
- designer
make_default
Makes a given ServerTemplateMultiCloudImage the default for the ServerTemplate.
- URLs
- POST /api/server_template_multi_cloud_images/:id/make_default
- HTTP response code
- 204 No Content
Required roles
- designer