Update Machine
Update machine. Only description, tag, custom property and bootConfig updates are supported. Please note that all existing tags, assigned to this machine, that are not implicitly added in the Patch body, will be unassigned from this machine!All other properties in the MachineSpecification body are ignored.
The ID of the Machine.
The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about
Machine Specification
{
"description": "string",
"tags": [
{
"key": "ownedBy",
"value": "Rainpole"
}
],
"customProperties": {
"customProperties": "string"
},
"bootConfig": {
"content": "#cloud-config\nrepo_update: true\nrepo_upgrade: all\n\npackages:\n - mysql-server\n\nruncmd:\n - sed -e '/bind-address/ s/^#*/#/' -i /etc/mysql/mysql.conf.d/mysqld.cnf\n - service mysql restart\n - mysql -e \"GRANT ALL PRIVILEGES ON *.* TO 'root'@'%' IDENTIFIED BY 'mysqlpassword';\"\n - mysql -e \"FLUSH PRIVILEGES;\"\n"
}
}Describes machine within the scope of your organization and is not propagated to the cloud
A set of tag keys and optional values that should be set on any resource that is produced from this specification.
Additional custom properties that may be used to extend the machine. Internal custom properties (for example, prefixed with: "__") are discarded.
Machine boot config that will be passed to the instance that can be used to perform common automated configuration tasks and even run scripts after the instance starts.
Successful operation
"Machine Object"The id of this resource instance
Date when the entity was created. The date is in ISO 8601 and UTC.
Date when the entity was last updated. The date is ISO 8601 and UTC.
Email of the user or display name of the group that owns the entity.
Type of a owner(user/ad_group) that owns the entity.
The id of the organization this entity belongs to.
HATEOAS of the entity
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
External entity Id on the provider side.
The id of the project this resource belongs to.
The external zoneId of the resource.
The external regionId of the resource.
Set of ids of the cloud accounts this resource belongs to.
Deployment id that is associated with this resource.
The provisioning status of the resource. One of three provisioning statuses.
PROVISIONING: The resource is being provisioned.
READY: The resource is already provisioned.
SUSPEND: The resource is being destroyed.
A set of tag keys and optional values that were set on this resource.
Additional properties that may be used to extend the base resource.
Power state of machine.
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.
Hostname associated with this machine instance.
Machine boot config that will be passed to the instance that can be used to perform common automated configuration tasks and even run scripts after the instance starts.
Represents salt configuration settings that has to be applied on the machine. To successfully apply the configurations, remoteAccess property is mandatory.The supported remoteAccess authentication types are usernamePassword and generatedPublicPrivateKey
Forbidden
"ServiceErrorResponse Object"message
messageId
stackTrace
statusCode
errorCode
details
serverErrorId
documentKind
internalErrorCode
Not found
"ServiceErrorResponse Object"message
messageId
stackTrace
statusCode
errorCode
details
serverErrorId
documentKind
internalErrorCode
curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}'