Cloud Management API 1.5
Publications
A Publication is a revisioned component shared with a set of Account Groups. If shared with your account, it can be imported in to your account.
Actions
index
Lists the publications available to this account. Only non-HEAD revisions are possible.
- URLs
- GET /api/publications
- HTTP response code
- 200 OK
- Content-type
- application/vnd.rightscale.publication;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 |
|---|---|---|
| description | yes | The description to filter on. |
| name | yes | The name to filter on. |
| publisher | yes | The publisher to filter on. |
| revision | no | The revision to filter on. |
Example Responses
Click on a format below to see an example response:
JSON XML[{
"created_at": 1696849561,
"updated_at": 1696849561,
"name": "NAME_2388878614",
"description": "DESCRIPTION_1820028841",
"revision": 5,
"commit_message": "A committed revision",
"content_type": "ServerTemplate",
"revision_notes": "REVISION_NOTES 3233047936",
"publisher": "org_3310574339",
"links": [
{"rel":"self","href":"/api/publications/1"},
{"rel":"lineage","href":"/api/publication_lineages/1"}
],
"actions": [
{
"rel": "import"
}
]
},{
"created_at": 1696849563,
"updated_at": 1696849563,
"name": "NAME_3756317910",
"description": "DESCRIPTION_2431435429",
"revision": 5,
"commit_message": "A committed revision",
"content_type": "ServerTemplate",
"revision_notes": "REVISION_NOTES 2678603873",
"publisher": "org_1292550129",
"links": [
{"rel":"self","href":"/api/publications/1"},
{"rel":"lineage","href":"/api/publication_lineages/1"}
],
"actions": [
{
"rel": "import"
}
]
}]<?xml version="1.0" encoding="UTF-8"?>
<publications>
<publication>
<created_at>1696849561</created_at>
<updated_at>1696849561</updated_at>
<name>NAME_2388878614</name>
<description>DESCRIPTION_1820028841</description>
<revision>5</revision>
<commit_message>A committed revision</commit_message>
<content_type>ServerTemplate</content_type>
<revision_notes>REVISION_NOTES 3233047936</revision_notes>
<publisher>org_3310574339</publisher>
<links>
<link rel="self" href="/api/publications/1"/>
<link rel="lineage" href="/api/publication_lineages/1"/>
</links>
<actions>
<action rel="import"/>
</actions>
</publication>
<publication>
<created_at>1696849563</created_at>
<updated_at>1696849563</updated_at>
<name>NAME_3756317910</name>
<description>DESCRIPTION_2431435429</description>
<revision>5</revision>
<commit_message>A committed revision</commit_message>
<content_type>ServerTemplate</content_type>
<revision_notes>REVISION_NOTES 2678603873</revision_notes>
<publisher>org_1292550129</publisher>
<links>
<link rel="self" href="/api/publications/1"/>
<link rel="lineage" href="/api/publication_lineages/1"/>
</links>
<actions>
<action rel="import"/>
</actions>
</publication>
</publications>
show
Show information about a single publication. Only non-HEAD revisions are possible.
- URLs
- GET /api/publications/:id
- HTTP response code
- 200 OK
- Content-type
- application/vnd.rightscale.publication
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": 1696849561,
"updated_at": 1696849561,
"name": "NAME_2388878614",
"description": "DESCRIPTION_1820028841",
"revision": 5,
"commit_message": "A committed revision",
"content_type": "ServerTemplate",
"revision_notes": "REVISION_NOTES 3233047936",
"publisher": "org_3310574339",
"links": [
{"rel":"self","href":"/api/publications/1"},
{"rel":"lineage","href":"/api/publication_lineages/1"}
],
"actions": [
{
"rel": "import"
}
]
}<?xml version="1.0" encoding="UTF-8"?>
<publication>
<created_at>1696849561</created_at>
<updated_at>1696849561</updated_at>
<name>NAME_2388878614</name>
<description>DESCRIPTION_1820028841</description>
<revision>5</revision>
<commit_message>A committed revision</commit_message>
<content_type>ServerTemplate</content_type>
<revision_notes>REVISION_NOTES 3233047936</revision_notes>
<publisher>org_3310574339</publisher>
<links>
<link rel="self" href="/api/publications/1"/>
<link rel="lineage" href="/api/publication_lineages/1"/>
</links>
<actions>
<action rel="import"/>
</actions>
</publication>
import
Imports the given publication and its subordinates to this account. Only non-HEAD revisions that are shared with the account can be imported.
- URLs
- POST /api/publications/:id/import
- HTTP response code
- 201 Created
- Location
- Href of the imported publication.
Required roles
- designer