Update Machine

Update Machine

Update machine. Only tag updates are supported. All other properties in the MachineSpecification body are ignored.

Request
URI
PATCH
https://{api_host}/iaas/api/machines/{id}
COPY
Path Parameters
string
id
Required

The ID of the Machine.

Query Parameters
string
apiVersion
Optional

The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /iaas/api/about

Request Body

Machine Specification

UpdateMachineSpecification of type(s) application/json
Required 
{
    "description": "string",
    "tags": [
        {
            "key": "string",
            "value": "string"
        }
    ]
}
string
description
Optional

Describes machine within the scope of your organization and is not propagated to the cloud

array of Tag
tags
Optional

A set of tag keys and optional values that should be set on any resource that is produced from this specification.

Responses
200

successful operation

Returns Machine of type(s) application/json 
{
    "id": "9e49",
    "createdAt": "2012-09-27",
    "updatedAt": "2012-09-27",
    "owner": "[email protected]",
    "organizationId": "deprecated",
    "orgId": "9e49",
    "name": "my-name",
    "description": "my-description",
    "externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
    "projectId": "9e49",
    "externalZoneId": "us-east-1a",
    "externalRegionId": "us-east-1",
    "cloudAccountIds": [
        "string"
    ],
    "powerState": "ON, OFF",
    "address": "34.242.21.5",
    "tags": [
        {
            "key": "string",
            "value": "string"
        }
    ]
}
string
id
Required

The id of this resource instance

string
createdAt
Optional

Date when the entity was created. The date is in ISO 6801 and UTC.

string
updatedAt
Optional

Date when the entity was last updated. The date is ISO 8601 and UTC.

string
owner
Optional

Email of the user that owns the entity.

string
organizationId
Optional

This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.

string
orgId
Optional

The id of the organization this entity belongs to.

object
_links
Required

HATEOAS of the entity

string
name
Optional

A human-friendly name used as an identifier in APIs that support this option.

string
description
Optional

A human-friendly description.

string
externalId
Optional

External entity Id on the provider side.

string
projectId
Optional

The id of the project this entity belongs to.

string
externalZoneId
Required

The external zoneId of the resource.

string
externalRegionId
Required

The external regionId of the resource

array of string
cloudAccountIds
Optional

Set of ids of the cloud accounts this entity belongs to.

string
powerState
Required

Power state of machine.

Possible values are : ON, OFF, GUEST_OFF, UNKNOWN, SUSPEND,
string
address
Optional

Primary address allocated or in use by this machine. The actual type of the address depends on the adapter type. Typically it is either the public or the external IP address.

array of Tag
tags
Optional

A set of tag keys and optional values that were set on this resource instance.

object
customProperties
Optional

Additional properties that may be used to extend the base type.


403

Forbidden

Operation doesn't return any data structure

404

Not Found

Operation doesn't return any data structure

On This Page
Compute Operations
POST
Create Machine
POST
Create Machine Snapshot
DELETE
Delete Machine
DELETE
Delete Machine Snapshot
GET
Get Machine
GET
Get Machines
GET
Get Machine Snapshots
POST
Power Off Machine
POST
Power On Machine
POST
Reboot Machine
POST
Reset Machine
POST
Resize Machine
POST
Restart Machine
POST
Revert Machine Snapshot
POST
Shutdown Machine
POST
Suspend Machine
PATCH
Update Machine