Cloud Management API 1.5

Servers

Servers represent the notion of a server/machine from the RightScale's perspective. A Server, does not always have a corresponding VM running or provisioned in a cloud. Some clouds use the word "servers" to refer to created VM's. These allocated VM's are not called Servers in the RightScale API, they are called Instances.

A Server always has a next_instance association, which will define the configuration to apply to a new instance when the server is launched or started (starting servers is not yet supported through this API). Once a Server is launched/started a current_instance relationship will exist. Accessing the current_instance of a server results in immediate runtime modification of this running server. Changes to the next_instance association prepares the configuration for the next instance launch/start (therefore they have no effect until such operation is performed).

Actions

index

Lists servers.

By using the available filters, it is possible to retrieve servers that have common characteristics. For example, one can list: * servers that have names that contain "app_server" * all servers of a given deployment

For more filters, please see the 'index' action on 'Instances' resource as most of the attributes belong to a 'current_instance' than to a server.

URLs
GET /api/deployments/:deployment_id/servers
GET /api/servers
HTTP response code
200 OK
Content-type
application/vnd.rightscale.server;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, instance_detail * no Specifies how many attributes and/or expanded nested relationships to include.

Filters

name partial_match? description
cloud_href no The href of the Cloud to filter on.
deployment_href no The href of the Deployment to filter on.
name yes The name of the Server to filter on.

Example Responses

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

JSON XML
[{
  "name": "nickname-2436735856",
  "description": "description_544080429",
  "created_at": "2017/11/15 19:57:40 +0000",
  "updated_at": "2017/11/15 19:57:41 +0000",
  "state": "operational",
  "links": [
    {"rel":"self","href":"/api/servers/1"},
    {"rel":"deployment","href":"/api/deployments/2"},
    {"rel":"current_instance","href":"/api/clouds/888/instances/RESOURCE_743469387;RAND"},
    {"rel":"next_instance","href":"/api/clouds/888/instances/41TPJUJUAF411"},
    {"rel":"alert_specs","href":"/api/servers/1/alert_specs"},
    {"rel":"alerts","href":"/api/servers/1/alerts"}
  ],
  "actions": [
    {
      "rel": "terminate"
    },
    {
      "rel": "clone"
    }
  ]
},{
  "name": "nickname-1967986838",
  "description": "description_3113328714",
  "created_at": "2017/11/15 19:57:42 +0000",
  "updated_at": "2017/11/15 19:57:42 +0000",
  "state": "operational",
  "links": [
    {"rel":"self","href":"/api/servers/3"},
    {"rel":"deployment","href":"/api/deployments/8"},
    {"rel":"current_instance","href":"/api/clouds/888/instances/RESOURCE_355574679;RAND"},
    {"rel":"next_instance","href":"/api/clouds/888/instances/3SHSM7B9HL609"},
    {"rel":"alert_specs","href":"/api/servers/3/alert_specs"},
    {"rel":"alerts","href":"/api/servers/3/alerts"}
  ],
  "actions": [
    {
      "rel": "terminate"
    },
    {
      "rel": "clone"
    }
  ]
}]
<?xml version="1.0" encoding="UTF-8"?>
<servers>
  <server>
    <name>nickname-2436735856</name>
    <description>description_544080429</description>
    <created_at>2017/11/15 19:57:40 +0000</created_at>
    <updated_at>2017/11/15 19:57:41 +0000</updated_at>
    <state>operational</state>
    <links>
      <link rel="self" href="/api/servers/1"/>
      <link rel="deployment" href="/api/deployments/2"/>
      <link rel="current_instance" href="/api/clouds/888/instances/RESOURCE_743469387;RAND"/>
      <link rel="next_instance" href="/api/clouds/888/instances/41TPJUJUAF411"/>
      <link rel="alert_specs" href="/api/servers/1/alert_specs"/>
      <link rel="alerts" href="/api/servers/1/alerts"/>
    </links>
    <actions>
      <action rel="terminate"/>
      <action rel="clone"/>
    </actions>
  </server>
  <server>
    <name>nickname-1967986838</name>
    <description>description_3113328714</description>
    <created_at>2017/11/15 19:57:42 +0000</created_at>
    <updated_at>2017/11/15 19:57:42 +0000</updated_at>
    <state>operational</state>
    <links>
      <link rel="self" href="/api/servers/3"/>
      <link rel="deployment" href="/api/deployments/8"/>
      <link rel="current_instance" href="/api/clouds/888/instances/RESOURCE_355574679;RAND"/>
      <link rel="next_instance" href="/api/clouds/888/instances/3SHSM7B9HL609"/>
      <link rel="alert_specs" href="/api/servers/3/alert_specs"/>
      <link rel="alerts" href="/api/servers/3/alerts"/>
    </links>
    <actions>
      <action rel="terminate"/>
      <action rel="clone"/>
    </actions>
  </server>
</servers>

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

JSON XML
[{
  "name": "nickname-2436735856",
  "description": "description_544080429",
  "created_at": "2017/11/15 19:57:40 +0000",
  "updated_at": "2017/11/15 19:57:41 +0000",
  "state": "operational",
  "links": [
    {"rel":"self","href":"/api/servers/1"},
    {"rel":"deployment","href":"/api/deployments/2"},
    {"rel":"current_instance","href":"/api/clouds/888/instances/RESOURCE_743469387;RAND"},
    {"rel":"next_instance","href":"/api/clouds/888/instances/41TPJUJUAF411"},
    {"rel":"alert_specs","href":"/api/servers/1/alert_specs"},
    {"rel":"alerts","href":"/api/servers/1/alerts"}
  ],
  "actions": [
    {
      "rel": "terminate"
    },
    {
      "rel": "clone"
    }
  ],
  "next_instance": {
    "name": "nickname-2436735856",
    "created_at": "2017/11/15 19:57:40 +0000",
    "updated_at": "2017/11/15 19:57:40 +0000",
    "resource_uid": "3cb1504c-ca3f-11e7-8bd8-02425d69ac40",
    "links": [
      {"rel":"self","href":"/api/clouds/888/instances/41TPJUJUAF411"},
      {"rel":"cloud","href":"/api/clouds/888"},
      {"rel":"deployment","href":"/api/deployments/2"},
      {"rel":"server_template","href":"/api/server_templates/1"},
      {"rel":"multi_cloud_image","href":"/api/multi_cloud_images/1","inherited_source":"server_template"},
      {"rel":"parent","href":"/api/servers/1"},
      {"rel":"volume_attachments","href":"/api/clouds/888/instances/41TPJUJUAF411/volume_attachments"},
      {"rel":"inputs","href":"/api/clouds/888/instances/41TPJUJUAF411/inputs"},
      {"rel":"monitoring_metrics","href":"/api/clouds/888/instances/41TPJUJUAF411/monitoring_metrics"},
      {"rel":"alerts","href":"/api/clouds/888/instances/41TPJUJUAF411/alerts"},
      {"rel":"alert_specs","href":"/api/clouds/888/instances/41TPJUJUAF411/alert_specs"}
    ],
    "cloud_specific_attributes": {},
    "associate_public_ip_address": true,
    "actions": [

    ],
    "public_ip_addresses": [

    ],
    "private_ip_addresses": [

    ],
    "pricing_type": "fixed",
    "locked": false,
    "state": "inactive"
  },
  "current_instance": {
    "name": "NAME_109530668",
    "created_at": "2017/11/15 19:57:41 +0000",
    "updated_at": "2017/11/15 19:57:41 +0000",
    "resource_uid": "RESOURCE_743469387",
    "links": [
      {"rel":"self","href":"/api/clouds/888/instances/RESOURCE_743469387;RAND"},
      {"rel":"cloud","href":"/api/clouds/888"},
      {"rel":"deployment","href":"/api/deployments/2"},
      {"rel":"server_template","href":"/api/server_templates/1"},
      {"rel":"multi_cloud_image","href":"/api/multi_cloud_images/1","inherited_source":"server_template"},
      {"rel":"parent","href":"/api/servers/1"},
      {"rel":"volume_attachments","href":"/api/clouds/888/instances/RESOURCE_743469387;RAND/volume_attachments"},
      {"rel":"inputs","href":"/api/clouds/888/instances/RESOURCE_743469387;RAND/inputs"},
      {"rel":"monitoring_metrics","href":"/api/clouds/888/instances/RESOURCE_743469387;RAND/monitoring_metrics"},
      {"rel":"alerts","href":"/api/clouds/888/instances/RESOURCE_743469387;RAND/alerts"},
      {"rel":"alert_specs","href":"/api/clouds/888/instances/RESOURCE_743469387;RAND/alert_specs"}
    ],
    "cloud_specific_attributes": {
    },
    "associate_public_ip_address": true,
    "actions": [
      {
        "rel": "terminate"
      },
      {
        "rel": "reboot"
      },
      {
        "rel": "run_executable"
      },
      {
        "rel": "lock"
      },
      {
        "rel": "unlock"
      }
    ],
    "public_ip_addresses": [
      "155.163.88.36"
    ],
    "private_ip_addresses": [
      "1.8.0.1"
    ],
    "pricing_type": "fixed",
    "locked": false,
    "state": "operational"
  }
},{
  "name": "nickname-1967986838",
  "description": "description_3113328714",
  "created_at": "2017/11/15 19:57:42 +0000",
  "updated_at": "2017/11/15 19:57:42 +0000",
  "state": "operational",
  "links": [
    {"rel":"self","href":"/api/servers/3"},
    {"rel":"deployment","href":"/api/deployments/8"},
    {"rel":"current_instance","href":"/api/clouds/888/instances/RESOURCE_355574679;RAND"},
    {"rel":"next_instance","href":"/api/clouds/888/instances/3SHSM7B9HL609"},
    {"rel":"alert_specs","href":"/api/servers/3/alert_specs"},
    {"rel":"alerts","href":"/api/servers/3/alerts"}
  ],
  "actions": [
    {
      "rel": "terminate"
    },
    {
      "rel": "clone"
    }
  ],
  "next_instance": {
    "name": "nickname-1967986838",
    "created_at": "2017/11/15 19:57:42 +0000",
    "updated_at": "2017/11/15 19:57:42 +0000",
    "resource_uid": "3dce0f92-ca3f-11e7-8bd8-02425d69ac40",
    "links": [
      {"rel":"self","href":"/api/clouds/888/instances/3SHSM7B9HL609"},
      {"rel":"cloud","href":"/api/clouds/888"},
      {"rel":"deployment","href":"/api/deployments/8"},
      {"rel":"server_template","href":"/api/server_templates/5"},
      {"rel":"multi_cloud_image","href":"/api/multi_cloud_images/2","inherited_source":"server_template"},
      {"rel":"parent","href":"/api/servers/3"},
      {"rel":"volume_attachments","href":"/api/clouds/888/instances/3SHSM7B9HL609/volume_attachments"},
      {"rel":"inputs","href":"/api/clouds/888/instances/3SHSM7B9HL609/inputs"},
      {"rel":"monitoring_metrics","href":"/api/clouds/888/instances/3SHSM7B9HL609/monitoring_metrics"},
      {"rel":"alerts","href":"/api/clouds/888/instances/3SHSM7B9HL609/alerts"},
      {"rel":"alert_specs","href":"/api/clouds/888/instances/3SHSM7B9HL609/alert_specs"}
    ],
    "cloud_specific_attributes": {},
    "associate_public_ip_address": true,
    "actions": [

    ],
    "public_ip_addresses": [

    ],
    "private_ip_addresses": [

    ],
    "pricing_type": "fixed",
    "locked": false,
    "state": "inactive"
  },
  "current_instance": {
    "name": "NAME_1080008741",
    "created_at": "2017/11/15 19:57:42 +0000",
    "updated_at": "2017/11/15 19:57:42 +0000",
    "resource_uid": "RESOURCE_355574679",
    "links": [
      {"rel":"self","href":"/api/clouds/888/instances/RESOURCE_355574679;RAND"},
      {"rel":"cloud","href":"/api/clouds/888"},
      {"rel":"deployment","href":"/api/deployments/8"},
      {"rel":"server_template","href":"/api/server_templates/5"},
      {"rel":"multi_cloud_image","href":"/api/multi_cloud_images/2","inherited_source":"server_template"},
      {"rel":"parent","href":"/api/servers/3"},
      {"rel":"volume_attachments","href":"/api/clouds/888/instances/RESOURCE_355574679;RAND/volume_attachments"},
      {"rel":"inputs","href":"/api/clouds/888/instances/RESOURCE_355574679;RAND/inputs"},
      {"rel":"monitoring_metrics","href":"/api/clouds/888/instances/RESOURCE_355574679;RAND/monitoring_metrics"},
      {"rel":"alerts","href":"/api/clouds/888/instances/RESOURCE_355574679;RAND/alerts"},
      {"rel":"alert_specs","href":"/api/clouds/888/instances/RESOURCE_355574679;RAND/alert_specs"}
    ],
    "cloud_specific_attributes": {
    },
    "associate_public_ip_address": true,
    "actions": [
      {
        "rel": "terminate"
      },
      {
        "rel": "reboot"
      },
      {
        "rel": "run_executable"
      },
      {
        "rel": "lock"
      },
      {
        "rel": "unlock"
      }
    ],
    "public_ip_addresses": [
      "133.24.174.205"
    ],
    "private_ip_addresses": [
      "9.0.1.4"
    ],
    "pricing_type": "fixed",
    "locked": false,
    "state": "operational"
  }
}]
<?xml version="1.0" encoding="UTF-8"?>
<servers>
  <server>
    <name>nickname-2436735856</name>
    <description>description_544080429</description>
    <created_at>2017/11/15 19:57:40 +0000</created_at>
    <updated_at>2017/11/15 19:57:41 +0000</updated_at>
    <state>operational</state>
    <links>
      <link rel="self" href="/api/servers/1"/>
      <link rel="deployment" href="/api/deployments/2"/>
      <link rel="current_instance" href="/api/clouds/888/instances/RESOURCE_743469387;RAND"/>
      <link rel="next_instance" href="/api/clouds/888/instances/41TPJUJUAF411"/>
      <link rel="alert_specs" href="/api/servers/1/alert_specs"/>
      <link rel="alerts" href="/api/servers/1/alerts"/>
    </links>
    <actions>
      <action rel="terminate"/>
      <action rel="clone"/>
    </actions>
    <next_instance>
      <name>nickname-2436735856</name>
      <created_at>2017/11/15 19:57:40 +0000</created_at>
      <updated_at>2017/11/15 19:57:40 +0000</updated_at>
      <resource_uid>3cb1504c-ca3f-11e7-8bd8-02425d69ac40</resource_uid>
      <links>
        <link rel="self" href="/api/clouds/888/instances/41TPJUJUAF411"/>
        <link rel="cloud" href="/api/clouds/888"/>
        <link rel="deployment" href="/api/deployments/2"/>
        <link rel="server_template" href="/api/server_templates/1"/>
        <link rel="multi_cloud_image" href="/api/multi_cloud_images/1" inherited_source="server_template"/>
        <link rel="parent" href="/api/servers/1"/>
        <link rel="volume_attachments" href="/api/clouds/888/instances/41TPJUJUAF411/volume_attachments"/>
        <link rel="inputs" href="/api/clouds/888/instances/41TPJUJUAF411/inputs"/>
        <link rel="monitoring_metrics" href="/api/clouds/888/instances/41TPJUJUAF411/monitoring_metrics"/>
        <link rel="alerts" href="/api/clouds/888/instances/41TPJUJUAF411/alerts"/>
        <link rel="alert_specs" href="/api/clouds/888/instances/41TPJUJUAF411/alert_specs"/>
      </links>
      <cloud_specific_attributes/>
      <associate_public_ip_address>true</associate_public_ip_address>
      <actions/>
      <public_ip_addresses/>
      <private_ip_addresses/>
      <pricing_type>fixed</pricing_type>
      <locked>false</locked>
      <state>inactive</state>
    </next_instance>
    <current_instance>
      <name>NAME_109530668</name>
      <created_at>2017/11/15 19:57:41 +0000</created_at>
      <updated_at>2017/11/15 19:57:41 +0000</updated_at>
      <resource_uid>RESOURCE_743469387</resource_uid>
      <links>
        <link rel="self" href="/api/clouds/888/instances/RESOURCE_743469387;RAND"/>
        <link rel="cloud" href="/api/clouds/888"/>
        <link rel="deployment" href="/api/deployments/2"/>
        <link rel="server_template" href="/api/server_templates/1"/>
        <link rel="multi_cloud_image" href="/api/multi_cloud_images/1" inherited_source="server_template"/>
        <link rel="parent" href="/api/servers/1"/>
        <link rel="volume_attachments" href="/api/clouds/888/instances/RESOURCE_743469387;RAND/volume_attachments"/>
        <link rel="inputs" href="/api/clouds/888/instances/RESOURCE_743469387;RAND/inputs"/>
        <link rel="monitoring_metrics" href="/api/clouds/888/instances/RESOURCE_743469387;RAND/monitoring_metrics"/>
        <link rel="alerts" href="/api/clouds/888/instances/RESOURCE_743469387;RAND/alerts"/>
        <link rel="alert_specs" href="/api/clouds/888/instances/RESOURCE_743469387;RAND/alert_specs"/>
      </links>
      <cloud_specific_attributes/>
      <associate_public_ip_address>true</associate_public_ip_address>
      <actions>
        <action rel="terminate"/>
        <action rel="reboot"/>
        <action rel="run_executable"/>
        <action rel="lock"/>
        <action rel="unlock"/>
      </actions>
      <public_ip_addresses>
        <public_ip_address>155.163.88.36</public_ip_address>
      </public_ip_addresses>
      <private_ip_addresses>
        <private_ip_address>1.8.0.1</private_ip_address>
      </private_ip_addresses>
      <pricing_type>fixed</pricing_type>
      <locked>false</locked>
      <state>operational</state>
    </current_instance>
  </server>
  <server>
    <name>nickname-1967986838</name>
    <description>description_3113328714</description>
    <created_at>2017/11/15 19:57:42 +0000</created_at>
    <updated_at>2017/11/15 19:57:42 +0000</updated_at>
    <state>operational</state>
    <links>
      <link rel="self" href="/api/servers/3"/>
      <link rel="deployment" href="/api/deployments/8"/>
      <link rel="current_instance" href="/api/clouds/888/instances/RESOURCE_355574679;RAND"/>
      <link rel="next_instance" href="/api/clouds/888/instances/3SHSM7B9HL609"/>
      <link rel="alert_specs" href="/api/servers/3/alert_specs"/>
      <link rel="alerts" href="/api/servers/3/alerts"/>
    </links>
    <actions>
      <action rel="terminate"/>
      <action rel="clone"/>
    </actions>
    <next_instance>
      <name>nickname-1967986838</name>
      <created_at>2017/11/15 19:57:42 +0000</created_at>
      <updated_at>2017/11/15 19:57:42 +0000</updated_at>
      <resource_uid>3dce0f92-ca3f-11e7-8bd8-02425d69ac40</resource_uid>
      <links>
        <link rel="self" href="/api/clouds/888/instances/3SHSM7B9HL609"/>
        <link rel="cloud" href="/api/clouds/888"/>
        <link rel="deployment" href="/api/deployments/8"/>
        <link rel="server_template" href="/api/server_templates/5"/>
        <link rel="multi_cloud_image" href="/api/multi_cloud_images/2" inherited_source="server_template"/>
        <link rel="parent" href="/api/servers/3"/>
        <link rel="volume_attachments" href="/api/clouds/888/instances/3SHSM7B9HL609/volume_attachments"/>
        <link rel="inputs" href="/api/clouds/888/instances/3SHSM7B9HL609/inputs"/>
        <link rel="monitoring_metrics" href="/api/clouds/888/instances/3SHSM7B9HL609/monitoring_metrics"/>
        <link rel="alerts" href="/api/clouds/888/instances/3SHSM7B9HL609/alerts"/>
        <link rel="alert_specs" href="/api/clouds/888/instances/3SHSM7B9HL609/alert_specs"/>
      </links>
      <cloud_specific_attributes/>
      <associate_public_ip_address>true</associate_public_ip_address>
      <actions/>
      <public_ip_addresses/>
      <private_ip_addresses/>
      <pricing_type>fixed</pricing_type>
      <locked>false</locked>
      <state>inactive</state>
    </next_instance>
    <current_instance>
      <name>NAME_1080008741</name>
      <created_at>2017/11/15 19:57:42 +0000</created_at>
      <updated_at>2017/11/15 19:57:42 +0000</updated_at>
      <resource_uid>RESOURCE_355574679</resource_uid>
      <links>
        <link rel="self" href="/api/clouds/888/instances/RESOURCE_355574679;RAND"/>
        <link rel="cloud" href="/api/clouds/888"/>
        <link rel="deployment" href="/api/deployments/8"/>
        <link rel="server_template" href="/api/server_templates/5"/>
        <link rel="multi_cloud_image" href="/api/multi_cloud_images/2" inherited_source="server_template"/>
        <link rel="parent" href="/api/servers/3"/>
        <link rel="volume_attachments" href="/api/clouds/888/instances/RESOURCE_355574679;RAND/volume_attachments"/>
        <link rel="inputs" href="/api/clouds/888/instances/RESOURCE_355574679;RAND/inputs"/>
        <link rel="monitoring_metrics" href="/api/clouds/888/instances/RESOURCE_355574679;RAND/monitoring_metrics"/>
        <link rel="alerts" href="/api/clouds/888/instances/RESOURCE_355574679;RAND/alerts"/>
        <link rel="alert_specs" href="/api/clouds/888/instances/RESOURCE_355574679;RAND/alert_specs"/>
      </links>
      <cloud_specific_attributes/>
      <associate_public_ip_address>true</associate_public_ip_address>
      <actions>
        <action rel="terminate"/>
        <action rel="reboot"/>
        <action rel="run_executable"/>
        <action rel="lock"/>
        <action rel="unlock"/>
      </actions>
      <public_ip_addresses>
        <public_ip_address>133.24.174.205</public_ip_address>
      </public_ip_addresses>
      <private_ip_addresses>
        <private_ip_address>9.0.1.4</private_ip_address>
      </private_ip_addresses>
      <pricing_type>fixed</pricing_type>
      <locked>false</locked>
      <state>operational</state>
    </current_instance>
  </server>
</servers>

show

Shows the information of a single server.

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

Required roles

Parameters

name required type values regexp blank? description
view no String default, instance_detail * 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": "nickname-2436735856",
  "description": "description_544080429",
  "created_at": "2017/11/15 19:57:40 +0000",
  "updated_at": "2017/11/15 19:57:41 +0000",
  "state": "operational",
  "links": [
    {"rel":"self","href":"/api/servers/1"},
    {"rel":"deployment","href":"/api/deployments/2"},
    {"rel":"current_instance","href":"/api/clouds/888/instances/RESOURCE_743469387;RAND"},
    {"rel":"next_instance","href":"/api/clouds/888/instances/41TPJUJUAF411"},
    {"rel":"alert_specs","href":"/api/servers/1/alert_specs"},
    {"rel":"alerts","href":"/api/servers/1/alerts"}
  ],
  "actions": [
    {
      "rel": "terminate"
    },
    {
      "rel": "clone"
    }
  ]
}
<?xml version="1.0" encoding="UTF-8"?>
<server>
  <name>nickname-2436735856</name>
  <description>description_544080429</description>
  <created_at>2017/11/15 19:57:40 +0000</created_at>
  <updated_at>2017/11/15 19:57:41 +0000</updated_at>
  <state>operational</state>
  <links>
    <link rel="self" href="/api/servers/1"/>
    <link rel="deployment" href="/api/deployments/2"/>
    <link rel="current_instance" href="/api/clouds/888/instances/RESOURCE_743469387;RAND"/>
    <link rel="next_instance" href="/api/clouds/888/instances/41TPJUJUAF411"/>
    <link rel="alert_specs" href="/api/servers/1/alert_specs"/>
    <link rel="alerts" href="/api/servers/1/alerts"/>
  </links>
  <actions>
    <action rel="terminate"/>
    <action rel="clone"/>
  </actions>
</server>

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

JSON XML
{
  "name": "nickname-2436735856",
  "description": "description_544080429",
  "created_at": "2017/11/15 19:57:40 +0000",
  "updated_at": "2017/11/15 19:57:41 +0000",
  "state": "operational",
  "links": [
    {"rel":"self","href":"/api/servers/1"},
    {"rel":"deployment","href":"/api/deployments/2"},
    {"rel":"current_instance","href":"/api/clouds/888/instances/RESOURCE_743469387;RAND"},
    {"rel":"next_instance","href":"/api/clouds/888/instances/41TPJUJUAF411"},
    {"rel":"alert_specs","href":"/api/servers/1/alert_specs"},
    {"rel":"alerts","href":"/api/servers/1/alerts"}
  ],
  "actions": [
    {
      "rel": "terminate"
    },
    {
      "rel": "clone"
    }
  ],
  "next_instance": {
    "name": "nickname-2436735856",
    "created_at": "2017/11/15 19:57:40 +0000",
    "updated_at": "2017/11/15 19:57:40 +0000",
    "resource_uid": "3cb1504c-ca3f-11e7-8bd8-02425d69ac40",
    "links": [
      {"rel":"self","href":"/api/clouds/888/instances/41TPJUJUAF411"},
      {"rel":"cloud","href":"/api/clouds/888"},
      {"rel":"deployment","href":"/api/deployments/2"},
      {"rel":"server_template","href":"/api/server_templates/1"},
      {"rel":"multi_cloud_image","href":"/api/multi_cloud_images/1","inherited_source":"server_template"},
      {"rel":"parent","href":"/api/servers/1"},
      {"rel":"volume_attachments","href":"/api/clouds/888/instances/41TPJUJUAF411/volume_attachments"},
      {"rel":"inputs","href":"/api/clouds/888/instances/41TPJUJUAF411/inputs"},
      {"rel":"monitoring_metrics","href":"/api/clouds/888/instances/41TPJUJUAF411/monitoring_metrics"},
      {"rel":"alerts","href":"/api/clouds/888/instances/41TPJUJUAF411/alerts"},
      {"rel":"alert_specs","href":"/api/clouds/888/instances/41TPJUJUAF411/alert_specs"}
    ],
    "cloud_specific_attributes": {},
    "associate_public_ip_address": true,
    "actions": [

    ],
    "public_ip_addresses": [

    ],
    "private_ip_addresses": [

    ],
    "pricing_type": "fixed",
    "locked": false,
    "state": "inactive"
  },
  "current_instance": {
    "name": "NAME_109530668",
    "created_at": "2017/11/15 19:57:41 +0000",
    "updated_at": "2017/11/15 19:57:41 +0000",
    "resource_uid": "RESOURCE_743469387",
    "links": [
      {"rel":"self","href":"/api/clouds/888/instances/RESOURCE_743469387;RAND"},
      {"rel":"cloud","href":"/api/clouds/888"},
      {"rel":"deployment","href":"/api/deployments/2"},
      {"rel":"server_template","href":"/api/server_templates/1"},
      {"rel":"multi_cloud_image","href":"/api/multi_cloud_images/1","inherited_source":"server_template"},
      {"rel":"parent","href":"/api/servers/1"},
      {"rel":"volume_attachments","href":"/api/clouds/888/instances/RESOURCE_743469387;RAND/volume_attachments"},
      {"rel":"inputs","href":"/api/clouds/888/instances/RESOURCE_743469387;RAND/inputs"},
      {"rel":"monitoring_metrics","href":"/api/clouds/888/instances/RESOURCE_743469387;RAND/monitoring_metrics"},
      {"rel":"alerts","href":"/api/clouds/888/instances/RESOURCE_743469387;RAND/alerts"},
      {"rel":"alert_specs","href":"/api/clouds/888/instances/RESOURCE_743469387;RAND/alert_specs"}
    ],
    "cloud_specific_attributes": {
    },
    "associate_public_ip_address": true,
    "actions": [
      {
        "rel": "terminate"
      },
      {
        "rel": "reboot"
      },
      {
        "rel": "run_executable"
      },
      {
        "rel": "lock"
      },
      {
        "rel": "unlock"
      }
    ],
    "public_ip_addresses": [
      "155.163.88.36"
    ],
    "private_ip_addresses": [
      "1.8.0.1"
    ],
    "pricing_type": "fixed",
    "locked": false,
    "state": "operational"
  }
}
<?xml version="1.0" encoding="UTF-8"?>
<server>
  <name>nickname-2436735856</name>
  <description>description_544080429</description>
  <created_at>2017/11/15 19:57:40 +0000</created_at>
  <updated_at>2017/11/15 19:57:41 +0000</updated_at>
  <state>operational</state>
  <links>
    <link rel="self" href="/api/servers/1"/>
    <link rel="deployment" href="/api/deployments/2"/>
    <link rel="current_instance" href="/api/clouds/888/instances/RESOURCE_743469387;RAND"/>
    <link rel="next_instance" href="/api/clouds/888/instances/41TPJUJUAF411"/>
    <link rel="alert_specs" href="/api/servers/1/alert_specs"/>
    <link rel="alerts" href="/api/servers/1/alerts"/>
  </links>
  <actions>
    <action rel="terminate"/>
    <action rel="clone"/>
  </actions>
  <next_instance>
    <name>nickname-2436735856</name>
    <created_at>2017/11/15 19:57:40 +0000</created_at>
    <updated_at>2017/11/15 19:57:40 +0000</updated_at>
    <resource_uid>3cb1504c-ca3f-11e7-8bd8-02425d69ac40</resource_uid>
    <links>
      <link rel="self" href="/api/clouds/888/instances/41TPJUJUAF411"/>
      <link rel="cloud" href="/api/clouds/888"/>
      <link rel="deployment" href="/api/deployments/2"/>
      <link rel="server_template" href="/api/server_templates/1"/>
      <link rel="multi_cloud_image" href="/api/multi_cloud_images/1" inherited_source="server_template"/>
      <link rel="parent" href="/api/servers/1"/>
      <link rel="volume_attachments" href="/api/clouds/888/instances/41TPJUJUAF411/volume_attachments"/>
      <link rel="inputs" href="/api/clouds/888/instances/41TPJUJUAF411/inputs"/>
      <link rel="monitoring_metrics" href="/api/clouds/888/instances/41TPJUJUAF411/monitoring_metrics"/>
      <link rel="alerts" href="/api/clouds/888/instances/41TPJUJUAF411/alerts"/>
      <link rel="alert_specs" href="/api/clouds/888/instances/41TPJUJUAF411/alert_specs"/>
    </links>
    <cloud_specific_attributes/>
    <associate_public_ip_address>true</associate_public_ip_address>
    <actions/>
    <public_ip_addresses/>
    <private_ip_addresses/>
    <pricing_type>fixed</pricing_type>
    <locked>false</locked>
    <state>inactive</state>
  </next_instance>
  <current_instance>
    <name>NAME_109530668</name>
    <created_at>2017/11/15 19:57:41 +0000</created_at>
    <updated_at>2017/11/15 19:57:41 +0000</updated_at>
    <resource_uid>RESOURCE_743469387</resource_uid>
    <links>
      <link rel="self" href="/api/clouds/888/instances/RESOURCE_743469387;RAND"/>
      <link rel="cloud" href="/api/clouds/888"/>
      <link rel="deployment" href="/api/deployments/2"/>
      <link rel="server_template" href="/api/server_templates/1"/>
      <link rel="multi_cloud_image" href="/api/multi_cloud_images/1" inherited_source="server_template"/>
      <link rel="parent" href="/api/servers/1"/>
      <link rel="volume_attachments" href="/api/clouds/888/instances/RESOURCE_743469387;RAND/volume_attachments"/>
      <link rel="inputs" href="/api/clouds/888/instances/RESOURCE_743469387;RAND/inputs"/>
      <link rel="monitoring_metrics" href="/api/clouds/888/instances/RESOURCE_743469387;RAND/monitoring_metrics"/>
      <link rel="alerts" href="/api/clouds/888/instances/RESOURCE_743469387;RAND/alerts"/>
      <link rel="alert_specs" href="/api/clouds/888/instances/RESOURCE_743469387;RAND/alert_specs"/>
    </links>
    <cloud_specific_attributes/>
    <associate_public_ip_address>true</associate_public_ip_address>
    <actions>
      <action rel="terminate"/>
      <action rel="reboot"/>
      <action rel="run_executable"/>
      <action rel="lock"/>
      <action rel="unlock"/>
    </actions>
    <public_ip_addresses>
      <public_ip_address>155.163.88.36</public_ip_address>
    </public_ip_addresses>
    <private_ip_addresses>
      <private_ip_address>1.8.0.1</private_ip_address>
    </private_ip_addresses>
    <pricing_type>fixed</pricing_type>
    <locked>false</locked>
    <state>operational</state>
  </current_instance>
</server>

create

Creates a new server, and configures its corresponding "next" instance with the received parameters.

URLs
POST /api/deployments/:deployment_id/servers
POST /api/servers
HTTP response code
201 Created
Location
Href of the created Server

Required roles

Parameters

name required type values regexp blank? description
server yes Hash * * no
server[deployment_href] no String * * no The href of the deployment to which the Server will be added.
server[description] no String * * no The Server description.
server[instance] yes Hash * * no
server[instance][associate_public_ip_address] no String true, false * no Specify whether or not you want a public IP assigned when this Instance is launched. Only applies to Network-enabled Instances. If this is not specified, it will default to true.
server[instance][cloud_href] yes String * * no The href of the cloud that the Server should be added to.
server[instance][cloud_specific_attributes] no Hash * * no Cloud specific attributes that have no generic rightscale abstraction
server[instance][cloud_specific_attributes][admin_username] no String * * no The user that will be granted administrative privileges. Supported by AzureRM cloud only. For more information, review the documentation.
server[instance][cloud_specific_attributes][automatic_instance_store_mapping] no String true, false * no A flag indicating whether instance store mapping should be enabled. Not supported in all Clouds.
server[instance][cloud_specific_attributes][availability_set] no String * * no Availability set for raw instance. Supported by Azure v2 cloud only.
server[instance][cloud_specific_attributes][create_boot_volume] no String true, false * no If enabled, the instance will launch into volume storage. Otherwise, it will boot to local storage.
server[instance][cloud_specific_attributes][create_default_port_forwarding_rules] no String true, false * no Automatically create default port forwarding rules (enabled by default). Supported by Azure cloud only.
server[instance][cloud_specific_attributes][delete_boot_volume] no String true, false * no If enabled, the associated volume will be deleted when the instance is terminated.
server[instance][cloud_specific_attributes][disk_gb] no Integer * * no The size of root disk. Supported by UCA cloud only.
server[instance][cloud_specific_attributes][iam_instance_profile] no String * * yes The name or ARN of the IAM Instance Profile (IIP) to associate with the instance (Amazon only)
server[instance][cloud_specific_attributes][keep_alive_id] no String * * no The id of keep alive. Supported by UCA cloud only.
server[instance][cloud_specific_attributes][keep_alive_url] no String * * no The ulr of keep alive. Supported by UCA cloud only.
server[instance][cloud_specific_attributes][local_ssd_count] no String * * no Additional local SSDs. Supported by GCE cloud only
server[instance][cloud_specific_attributes][local_ssd_interface] no String * * no The type of SSD(s) to be created. Supported by GCE cloud only
server[instance][cloud_specific_attributes][max_spot_price] no String * * no Specify the max spot price you will pay for. Required when 'pricing_type' is 'spot'. Only applies to clouds which support spot-pricing and when 'spot' is chosen as the 'pricing_type'. Should be a Float value >= 0.001, eg: 0.095, 0.123, 1.23, etc...
server[instance][cloud_specific_attributes][memory_mb] no Integer * * no The size of instance memory. Supported by UCA cloud only.
server[instance][cloud_specific_attributes][metadata] no String * * no Extra data used for configuration, in query string format.
server[instance][cloud_specific_attributes][num_cores] no Integer * * no The number of instance cores. Supported by UCA cloud only.
server[instance][cloud_specific_attributes][placement_tenancy] no String default, dedicated * no The tenancy of the server you want to launch. A server with a tenancy of dedicated runs on single-tenant hardware and can only be launched into a VPC.
server[instance][cloud_specific_attributes][preemptible] no String true, false * no Launch a preemptible instance. A preemptible instance costs much less, but lasts only 24 hours. It can be terminated sooner due to system demands. Supported by GCE cloud only.
server[instance][cloud_specific_attributes][pricing_type] no String fixed, spot * no Specify whether or not you want to utilize 'fixed' (on-demand) or 'spot' pricing. Defaults to 'fixed' and only applies to clouds which support spot instances. Can only be set on when creating a new Instance, Server, or ServerArray, or when updating a Server or ServerArray's next_instance.WARNING: By using spot pricing, you acknowledge that your instance/server/array may not be able to be launched (and arrays may be unable to grow) as newly launched instances might be stuck in bidding, and/or existing instances may be terminated at any time, due to the cloud's spot pricing changes and availability.
server[instance][cloud_specific_attributes][root_volume_performance] no String * * no The number of IOPS (I/O Operations Per Second) this root volume should support. Only available on clouds supporting performance provisioning.
server[instance][cloud_specific_attributes][root_volume_size] no String * * no The size for root disk. Not supported in all Clouds.
server[instance][cloud_specific_attributes][root_volume_type_uid] no String * * no The type of root volume for instance. Only available on clouds supporting root volume type.
server[instance][cloud_specific_attributes][service_account] no String * * no Email of service account for instance. Scope will default to cloud-platform. Supported by GCE cloud only.
server[instance][datacenter_href] no String * * no The href of the Datacenter / Zone.
server[instance][image_href] no String * * no The href of the Image to use.
server[instance][inputs] no Enumerable * * no
server[instance][inputs][*] no String * * no The format used for passing 2.0-style Inputs. The key is the name of the Input, and the value is the value to assign to the Input. For more details on 2.0-style Inputs, please see Inputs#multi_update.
server[instance][inputs][][name] no String * * no The Input name. This format is used for passing legacy 1.0-style Inputs. Will eventually be deprecated.
server[instance][inputs][][value] no String * * no The value of that Input. Should be of the form 'text:my_value' or 'cred:MY_CRED' etc. This format is used for passing legacy 1.0-style Inputs. Will eventually be deprecated.
server[instance][instance_type_href] no String * * no The href of the Instance Type.
server[instance][ip_forwarding_enabled] no String true, false * no Allows this Instance to send and receive network traffic when the source and destination IP addresses do not match the IP address of this Instance.
server[instance][kernel_image_href] no String * * no The href of the Kernel Image.
server[instance][multi_cloud_image_href] no String * * no The href of the Multi Cloud Image to use.
server[instance][placement_group_href] no String * * no The href of the Placement Group.
server[instance][private_ip_address] no String * * no The private ip address for the instance
server[instance][ramdisk_image_href] no String * * no The href of the Ramdisk Image.
server[instance][security_group_hrefs] no Array * * no The hrefs of the security groups.
server[instance][server_template_href] yes String * * no The href of the Server Template.
server[instance][ssh_key_href] no String * * no The href of the SSH key to use.
server[instance][subnet_hrefs] no Array * * no The hrefs of the updated subnets.
server[instance][user_data] no String * * no User data that RightScale automatically passes to your instance at boot time.
server[name] yes String * * no The name of the Server.
server[optimized] no String true, false * no A flag indicating whether Instances of this Server should be optimized for high-performance volumes (e.g. Volumes supporting a specified number of IOPS). Not supported in all Clouds.

update

Updates attributes of a single server.

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

Required roles

Parameters

name required type values regexp blank? description
server yes Hash * * no
server[automatic_instance_store_mapping] no String true, false * no A flag indicating whether instance store mapping should be enabled. Not supported in all Clouds.
server[deployment_href] no String * * no The updated deployment of the server.
server[description] no String * * no The updated description for the server.
server[instance] no Hash * * no
server[instance][cloud_specific_attributes] no Hash * * no Cloud specific attributes that have no generic rightscale abstraction
server[instance][cloud_specific_attributes][create_boot_volume] no String true, false * no If enabled, the instance will launch into volume storage. Otherwise, it will boot to local storage.
server[instance][cloud_specific_attributes][delete_boot_volume] no String true, false * no If enabled, the associated volume will be deleted when the instance is terminated.
server[name] no String * * no The updated server name.
server[optimized] no String true, false * no A flag indicating whether Instances of this Server should be optimized for high-performance volumes (e.g. Volumes supporting a specified number of IOPS). Not supported in all Clouds.
server[root_volume_size] no String * * no The size for root disk. Not supported in all Clouds.

destroy

Deletes a given server.

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

Required roles

clone

Clones a given server.

URLs
POST /api/servers/:id/clone
HTTP response code
201 Created
Location
Href of the newly cloned Server

Required roles

disable_runnable_bindings

Disables a list of runnable bindings associated with a given server.

URLs
POST /api/servers/:id/disable_runnable_bindings
HTTP response code
204 No Content

Required roles

Parameters

name required type values regexp blank? description
runnable_binding_hrefs no Array * * no List of Runnable Bindings.

enable_runnable_bindings

Enables a list of runnable bindings associated with a given server.

URLs
POST /api/servers/:id/enable_runnable_bindings
HTTP response code
204 No Content

Required roles

Parameters

name required type values regexp blank? description
runnable_binding_hrefs no Array * * no List of Runnable Bindings.

launch

Launches the "next" instance of this server. This function is equivalent to invoking the launch action on the URL of this servers next_instance. See Instances#launch for details.

terminate

Terminates the current instance of this server. This function is equivalent to invoking the terminate action on the URL of this servers current_instance. See Instances#terminate for details.

unwrap

URLs
POST /api/deployments/:deployment_id/servers/:id/unwrap
POST /api/servers/:id/unwrap
HTTP response code
204 No Content

Required roles

wrap_instance

Wrap an existing instance and set current instance for new server

URLs
POST /api/deployments/:deployment_id/servers/wrap_instance
POST /api/servers/wrap_instance
HTTP response code
201 Created
Location
Href of the created Server

Required roles

Parameters

name required type values regexp blank? description
server yes Hash * * no
server[deployment_href] no String * * no The href of the deployment to which the Server will be added.
server[description] no String * * no The Server description.
server[instance] yes Hash * * no
server[instance][href] yes String * * no The href of the Instance around which the server should be created.
server[instance][inputs] no Enumerable * * no
server[instance][inputs][*] no String * * no The format used for passing 2.0-style Inputs. The key is the name of the Input, and the value is the value to assign to the Input. For more details on 2.0-style Inputs, please see Inputs#multi_update.
server[instance][multi_cloud_image_href] no String * * no The href of the Multi Cloud Image to use.
server[instance][server_template_href] yes String * * no The href of the Server Template.
server[name] no String * * no The name of the Server.