Cloud Management API 1.5

Deployments

Deployments represent logical groupings of related assets such as servers, server arrays, default configuration settings...etc.

Actions

index

Lists deployments of the account.

Using the available filters, one can select or group which deployments to retrieve. The 'inputs_2_0' view is for retrieving inputs in 2.0 serialization (for more details please see Inputs#index.)

URLs
GET /api/deployments
HTTP response code
200 OK
Content-type
application/vnd.rightscale.deployment;type=collection

Required roles

Parameters

name required type values regexp blank? description
filter no Array * * no See below for valid filter parameters.
view no String default, inputs, inputs_2_0 * no Specifies how many attributes and/or expanded nested relationships to include.

Filters

name partial_match? description
description yes The deployment description field to filter on.
name yes The name of the deployment to filter on.
resource_group_href no Resource Group href to filter on.
server_tag_scope yes The routing scope for tags for servers in the deployment.

Example Responses

Click on a format below to see an example response for the 'default' view:

JSON XML
[{
  "name": "TEST_NICKNAME-2819650813",
  "description": null,
  "locked": false,
  "server_tag_scope": "deployment",
  "links": [
    {"rel":"inputs","href":"/api/deployments/2/inputs"},
    {"rel":"self","href":"/api/deployments/2"},
    {"rel":"servers","href":"/api/deployments/2/servers"},
    {"rel":"server_arrays","href":"/api/deployments/2/server_arrays"},
    {"rel":"alerts","href":"/api/deployments/2/alerts"}
  ],
  "actions": [
    {
      "rel": "clone"
    },
    {
      "rel": "lock"
    },
    {
      "rel": "unlock"
    }
  ]
},{
  "name": "TEST_NICKNAME-3766444740",
  "description": null,
  "locked": false,
  "server_tag_scope": "deployment",
  "links": [
    {"rel":"inputs","href":"/api/deployments/8/inputs"},
    {"rel":"self","href":"/api/deployments/8"},
    {"rel":"servers","href":"/api/deployments/8/servers"},
    {"rel":"server_arrays","href":"/api/deployments/8/server_arrays"},
    {"rel":"alerts","href":"/api/deployments/8/alerts"}
  ],
  "actions": [
    {
      "rel": "clone"
    },
    {
      "rel": "lock"
    },
    {
      "rel": "unlock"
    }
  ]
}]
<?xml version="1.0" encoding="UTF-8"?>
<deployments>
  <deployment>
    <name>TEST_NICKNAME-2819650813</name>
    <description/>
    <locked>false</locked>
    <server_tag_scope>deployment</server_tag_scope>
    <links>
      <link rel="inputs" href="/api/deployments/2/inputs"/>
      <link rel="self" href="/api/deployments/2"/>
      <link rel="servers" href="/api/deployments/2/servers"/>
      <link rel="server_arrays" href="/api/deployments/2/server_arrays"/>
      <link rel="alerts" href="/api/deployments/2/alerts"/>
    </links>
    <actions>
      <action rel="clone"/>
      <action rel="lock"/>
      <action rel="unlock"/>
    </actions>
  </deployment>
  <deployment>
    <name>TEST_NICKNAME-3766444740</name>
    <description/>
    <locked>false</locked>
    <server_tag_scope>deployment</server_tag_scope>
    <links>
      <link rel="inputs" href="/api/deployments/8/inputs"/>
      <link rel="self" href="/api/deployments/8"/>
      <link rel="servers" href="/api/deployments/8/servers"/>
      <link rel="server_arrays" href="/api/deployments/8/server_arrays"/>
      <link rel="alerts" href="/api/deployments/8/alerts"/>
    </links>
    <actions>
      <action rel="clone"/>
      <action rel="lock"/>
      <action rel="unlock"/>
    </actions>
  </deployment>
</deployments>

Click on a format below to see an example response for the 'inputs' view:

JSON XML
[{
  "name": "TEST_NICKNAME-2819650813",
  "description": null,
  "locked": false,
  "server_tag_scope": "deployment",
  "links": [
    {"rel":"inputs","href":"/api/deployments/2/inputs"},
    {"rel":"self","href":"/api/deployments/2"},
    {"rel":"servers","href":"/api/deployments/2/servers"},
    {"rel":"server_arrays","href":"/api/deployments/2/server_arrays"},
    {"rel":"alerts","href":"/api/deployments/2/alerts"}
  ],
  "actions": [
    {
      "rel": "clone"
    },
    {
      "rel": "lock"
    },
    {
      "rel": "unlock"
    }
  ],
  "inputs": [
    {
      "name": "input_definition_1849073844",
      "value": "text:"
    },
    {
      "name": "input_definition_504519521",
      "value": "text:"
    }
  ]
},{
  "name": "TEST_NICKNAME-3766444740",
  "description": null,
  "locked": false,
  "server_tag_scope": "deployment",
  "links": [
    {"rel":"inputs","href":"/api/deployments/8/inputs"},
    {"rel":"self","href":"/api/deployments/8"},
    {"rel":"servers","href":"/api/deployments/8/servers"},
    {"rel":"server_arrays","href":"/api/deployments/8/server_arrays"},
    {"rel":"alerts","href":"/api/deployments/8/alerts"}
  ],
  "actions": [
    {
      "rel": "clone"
    },
    {
      "rel": "lock"
    },
    {
      "rel": "unlock"
    }
  ],
  "inputs": [
    {
      "name": "input_definition_2027045204",
      "value": "text:"
    },
    {
      "name": "input_definition_4000366314",
      "value": "text:"
    }
  ]
}]
<?xml version="1.0" encoding="UTF-8"?>
<deployments>
  <deployment>
    <name>TEST_NICKNAME-2819650813</name>
    <description/>
    <locked>false</locked>
    <server_tag_scope>deployment</server_tag_scope>
    <links>
      <link rel="inputs" href="/api/deployments/2/inputs"/>
      <link rel="self" href="/api/deployments/2"/>
      <link rel="servers" href="/api/deployments/2/servers"/>
      <link rel="server_arrays" href="/api/deployments/2/server_arrays"/>
      <link rel="alerts" href="/api/deployments/2/alerts"/>
    </links>
    <actions>
      <action rel="clone"/>
      <action rel="lock"/>
      <action rel="unlock"/>
    </actions>
    <inputs>
      <input>
        <name>input_definition_1849073844</name>
        <value>text:</value>
      </input>
      <input>
        <name>input_definition_504519521</name>
        <value>text:</value>
      </input>
    </inputs>
  </deployment>
  <deployment>
    <name>TEST_NICKNAME-3766444740</name>
    <description/>
    <locked>false</locked>
    <server_tag_scope>deployment</server_tag_scope>
    <links>
      <link rel="inputs" href="/api/deployments/8/inputs"/>
      <link rel="self" href="/api/deployments/8"/>
      <link rel="servers" href="/api/deployments/8/servers"/>
      <link rel="server_arrays" href="/api/deployments/8/server_arrays"/>
      <link rel="alerts" href="/api/deployments/8/alerts"/>
    </links>
    <actions>
      <action rel="clone"/>
      <action rel="lock"/>
      <action rel="unlock"/>
    </actions>
    <inputs>
      <input>
        <name>input_definition_2027045204</name>
        <value>text:</value>
      </input>
      <input>
        <name>input_definition_4000366314</name>
        <value>text:</value>
      </input>
    </inputs>
  </deployment>
</deployments>

Click on a format below to see an example response for the 'inputs_2_0' view:

JSON XML
[{
  "name": "TEST_NICKNAME-2819650813",
  "description": null,
  "locked": false,
  "server_tag_scope": "deployment",
  "links": [
    {"rel":"inputs","href":"/api/deployments/2/inputs"},
    {"rel":"self","href":"/api/deployments/2"},
    {"rel":"servers","href":"/api/deployments/2/servers"},
    {"rel":"server_arrays","href":"/api/deployments/2/server_arrays"},
    {"rel":"alerts","href":"/api/deployments/2/alerts"}
  ],
  "actions": [
    {
      "rel": "clone"
    },
    {
      "rel": "lock"
    },
    {
      "rel": "unlock"
    }
  ],
  "inputs": [
    {
      "name": "input_definition_1849073844",
      "value": "blank"
    },
    {
      "name": "input_definition_504519521",
      "value": "blank"
    }
  ]
},{
  "name": "TEST_NICKNAME-3766444740",
  "description": null,
  "locked": false,
  "server_tag_scope": "deployment",
  "links": [
    {"rel":"inputs","href":"/api/deployments/8/inputs"},
    {"rel":"self","href":"/api/deployments/8"},
    {"rel":"servers","href":"/api/deployments/8/servers"},
    {"rel":"server_arrays","href":"/api/deployments/8/server_arrays"},
    {"rel":"alerts","href":"/api/deployments/8/alerts"}
  ],
  "actions": [
    {
      "rel": "clone"
    },
    {
      "rel": "lock"
    },
    {
      "rel": "unlock"
    }
  ],
  "inputs": [
    {
      "name": "input_definition_2027045204",
      "value": "blank"
    },
    {
      "name": "input_definition_4000366314",
      "value": "blank"
    }
  ]
}]
<?xml version="1.0" encoding="UTF-8"?>
<deployments>
  <deployment>
    <name>TEST_NICKNAME-2819650813</name>
    <description/>
    <locked>false</locked>
    <server_tag_scope>deployment</server_tag_scope>
    <links>
      <link rel="inputs" href="/api/deployments/2/inputs"/>
      <link rel="self" href="/api/deployments/2"/>
      <link rel="servers" href="/api/deployments/2/servers"/>
      <link rel="server_arrays" href="/api/deployments/2/server_arrays"/>
      <link rel="alerts" href="/api/deployments/2/alerts"/>
    </links>
    <actions>
      <action rel="clone"/>
      <action rel="lock"/>
      <action rel="unlock"/>
    </actions>
    <inputs>
      <input>
        <name>input_definition_1849073844</name>
        <value>blank</value>
      </input>
      <input>
        <name>input_definition_504519521</name>
        <value>blank</value>
      </input>
    </inputs>
  </deployment>
  <deployment>
    <name>TEST_NICKNAME-3766444740</name>
    <description/>
    <locked>false</locked>
    <server_tag_scope>deployment</server_tag_scope>
    <links>
      <link rel="inputs" href="/api/deployments/8/inputs"/>
      <link rel="self" href="/api/deployments/8"/>
      <link rel="servers" href="/api/deployments/8/servers"/>
      <link rel="server_arrays" href="/api/deployments/8/server_arrays"/>
      <link rel="alerts" href="/api/deployments/8/alerts"/>
    </links>
    <actions>
      <action rel="clone"/>
      <action rel="lock"/>
      <action rel="unlock"/>
    </actions>
    <inputs>
      <input>
        <name>input_definition_2027045204</name>
        <value>blank</value>
      </input>
      <input>
        <name>input_definition_4000366314</name>
        <value>blank</value>
      </input>
    </inputs>
  </deployment>
</deployments>

show

Lists the attributes of a given deployment.

The 'inputs_2_0' view is for retrieving inputs in 2.0 serialization (for more details please see Inputs#index.)

URLs
GET /api/deployments/:id
HTTP response code
200 OK
Content-type
application/vnd.rightscale.deployment

Required roles

Parameters

name required type values regexp blank? description
view no String default, inputs, inputs_2_0 * no Specifies how many attributes and/or expanded nested relationships to include.

Example Responses

Click on a format below to see an example response for the 'default' view:

JSON XML
{
  "name": "TEST_NICKNAME-2819650813",
  "description": null,
  "locked": false,
  "server_tag_scope": "deployment",
  "links": [
    {"rel":"inputs","href":"/api/deployments/2/inputs"},
    {"rel":"self","href":"/api/deployments/2"},
    {"rel":"servers","href":"/api/deployments/2/servers"},
    {"rel":"server_arrays","href":"/api/deployments/2/server_arrays"},
    {"rel":"alerts","href":"/api/deployments/2/alerts"}
  ],
  "actions": [
    {
      "rel": "clone"
    },
    {
      "rel": "lock"
    },
    {
      "rel": "unlock"
    }
  ]
}
<?xml version="1.0" encoding="UTF-8"?>
<deployment>
  <name>TEST_NICKNAME-2819650813</name>
  <description/>
  <locked>false</locked>
  <server_tag_scope>deployment</server_tag_scope>
  <links>
    <link rel="inputs" href="/api/deployments/2/inputs"/>
    <link rel="self" href="/api/deployments/2"/>
    <link rel="servers" href="/api/deployments/2/servers"/>
    <link rel="server_arrays" href="/api/deployments/2/server_arrays"/>
    <link rel="alerts" href="/api/deployments/2/alerts"/>
  </links>
  <actions>
    <action rel="clone"/>
    <action rel="lock"/>
    <action rel="unlock"/>
  </actions>
</deployment>

Click on a format below to see an example response for the 'inputs' view:

JSON XML
{
  "name": "TEST_NICKNAME-2819650813",
  "description": null,
  "locked": false,
  "server_tag_scope": "deployment",
  "links": [
    {"rel":"inputs","href":"/api/deployments/2/inputs"},
    {"rel":"self","href":"/api/deployments/2"},
    {"rel":"servers","href":"/api/deployments/2/servers"},
    {"rel":"server_arrays","href":"/api/deployments/2/server_arrays"},
    {"rel":"alerts","href":"/api/deployments/2/alerts"}
  ],
  "actions": [
    {
      "rel": "clone"
    },
    {
      "rel": "lock"
    },
    {
      "rel": "unlock"
    }
  ],
  "inputs": [
    {
      "name": "input_definition_1849073844",
      "value": "text:"
    },
    {
      "name": "input_definition_504519521",
      "value": "text:"
    }
  ]
}
<?xml version="1.0" encoding="UTF-8"?>
<deployment>
  <name>TEST_NICKNAME-2819650813</name>
  <description/>
  <locked>false</locked>
  <server_tag_scope>deployment</server_tag_scope>
  <links>
    <link rel="inputs" href="/api/deployments/2/inputs"/>
    <link rel="self" href="/api/deployments/2"/>
    <link rel="servers" href="/api/deployments/2/servers"/>
    <link rel="server_arrays" href="/api/deployments/2/server_arrays"/>
    <link rel="alerts" href="/api/deployments/2/alerts"/>
  </links>
  <actions>
    <action rel="clone"/>
    <action rel="lock"/>
    <action rel="unlock"/>
  </actions>
  <inputs>
    <input>
      <name>input_definition_1849073844</name>
      <value>text:</value>
    </input>
    <input>
      <name>input_definition_504519521</name>
      <value>text:</value>
    </input>
  </inputs>
</deployment>

Click on a format below to see an example response for the 'inputs_2_0' view:

JSON XML
{
  "name": "TEST_NICKNAME-2819650813",
  "description": null,
  "locked": false,
  "server_tag_scope": "deployment",
  "links": [
    {"rel":"inputs","href":"/api/deployments/2/inputs"},
    {"rel":"self","href":"/api/deployments/2"},
    {"rel":"servers","href":"/api/deployments/2/servers"},
    {"rel":"server_arrays","href":"/api/deployments/2/server_arrays"},
    {"rel":"alerts","href":"/api/deployments/2/alerts"}
  ],
  "actions": [
    {
      "rel": "clone"
    },
    {
      "rel": "lock"
    },
    {
      "rel": "unlock"
    }
  ],
  "inputs": [
    {
      "name": "input_definition_1849073844",
      "value": "blank"
    },
    {
      "name": "input_definition_504519521",
      "value": "blank"
    }
  ]
}
<?xml version="1.0" encoding="UTF-8"?>
<deployment>
  <name>TEST_NICKNAME-2819650813</name>
  <description/>
  <locked>false</locked>
  <server_tag_scope>deployment</server_tag_scope>
  <links>
    <link rel="inputs" href="/api/deployments/2/inputs"/>
    <link rel="self" href="/api/deployments/2"/>
    <link rel="servers" href="/api/deployments/2/servers"/>
    <link rel="server_arrays" href="/api/deployments/2/server_arrays"/>
    <link rel="alerts" href="/api/deployments/2/alerts"/>
  </links>
  <actions>
    <action rel="clone"/>
    <action rel="lock"/>
    <action rel="unlock"/>
  </actions>
  <inputs>
    <input>
      <name>input_definition_1849073844</name>
      <value>blank</value>
    </input>
    <input>
      <name>input_definition_504519521</name>
      <value>blank</value>
    </input>
  </inputs>
</deployment>

create

Creates a new deployment with the given parameters.

URLs
POST /api/deployments
HTTP response code
201 Created
Location
Href of the created deployment

Required roles

Required settings

Parameters

name required type values regexp blank? description
deployment yes Hash * * no
deployment[description] no String * * yes The description of the deployment to be created.
deployment[name] yes String * * no The name of the deployment to be created.
deployment[resource_group_href] no String * * no The href of the Windows Azure Resource Group attached to the deployment.
deployment[server_tag_scope] no String deployment, account * yes The routing scope for tags for servers in the deployment.

update

Updates attributes of a given deployment.

URLs
PUT /api/deployments/:id
HTTP response code
204 No Content

Required roles

Required settings

Parameters

name required type values regexp blank? description
deployment yes Hash * * no
deployment[description] no String * * yes The updated description for the deployment.
deployment[name] no String * * no The updated name for the deployment.
deployment[resource_group_href] no String * * no The href of the Windows Azure Resource Group attached to the deployment.
deployment[server_tag_scope] no String deployment, account * yes The routing scope for tags for servers in the deployment.

destroy

Deletes a given deployment.

URLs
DELETE /api/deployments/:id
HTTP response code
204 No Content

Required roles

Required settings

clone

Clones a given deployment.

URLs
POST /api/deployments/:id/clone
HTTP response code
201 Created
Location
Href of the cloned deployment

Required roles

Required settings

Parameters

name required type values regexp blank? description
deployment no Hash * * no
deployment[description] no String * * yes The description for the cloned deployment.
deployment[name] no String * * no The name for the cloned deployment.
deployment[server_tag_scope] no String deployment, account * yes The routing scope for tags for servers in the cloned deployment.

lock

Locks a given deployment. Idempotent. Locking prevents servers from being deleted or moved from the deployment. Other actions such as adding servers or renaming the deployment are still allowed.

URLs
POST /api/deployments/:id/lock
HTTP response code
204 No Content

Required roles

servers

Lists the servers belonging to this deployment. This call is equivalent to servers#index call, where the servers returned will automatically be filtered by this deployment. See servers#index for details on other options and parameters.

unlock

Unlocks a given deployment. Idempotent.

URLs
POST /api/deployments/:id/unlock
HTTP response code
204 No Content

Required roles