Create Machine

Create Machine

Create machine

Request
URI
POST
https://{api_host}/iaas/api/machines
COPY
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 instance

MachineSpecification of type(s) application/json
Required 
"MachineSpecification Object"
string
image
Required

Type of image used for this machine.

array of object
disks
Optional

A set of disk specifications for this machine.

array of object
imageDiskConstraints
Optional

Constraints that are used to drive placement policies for the image disk. Constraint expressions are matched against tags on existing placement targets.

string
description
Optional

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

integer As int32 As int32
machineCount
Optional

Number of machines to provision - default 1.

array of object
constraints
Optional

Constraints that are used to drive placement policies for the virtual machine that is produced from this specification. Constraint expressions are matched against tags on existing placement targets.

array of object
tags
Optional

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

string
flavor
Required

Flavor of machine instance.

object
customProperties
Optional

Additional custom properties that may be used to extend the machine.

object
bootConfig
Optional

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.

string
name
Required

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

array of object
nics
Optional

A set of network interface controller specifications for this machine. If not specified, then a default network connection will be created.

string
imageRef
Required

Direct image reference used for this machine (name, path, location, uri, etc.). Valid if no image property is provided

string
projectId
Required

The id of the project the current user belongs to.

Responses
202

successful operation

Returns RequestTracker of type(s) application/json 
{
    "name": "Power-off",
    "progress": 90,
    "resources": [
        "string"
    ],
    "id": "we655aew4e8e",
    "message": "In Progress",
    "status": "FINISHED",
    "selfLink": "/.../request-tracker/we655aew4e8e"
}
string
name
Optional

Name of the operation.

integer As int32 As int32
progress
Required

Progress of the request as percentage.

array of string
resources
Optional

Collection of resources.

string
id
Required

ID of this request.

string
message
Optional

Status message of the request.

string
status
Required

Status of the request.

Possible values are : FINISHED, INPROGRESS, FAILED,
string
selfLink
Required

Self link of this request.


400

Invalid Request - bad data

Operation doesn't return any data structure

403

Forbidden

Operation doesn't return any data structure

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/iaas/api/machines
On This Page
Compute Operations
POST
Restart Machine
POST
Resize Machine
GET
Get Machine Snapshots
POST
Create Machine
GET
Get Machines
POST
Reboot Machine
POST
Create Machine Snapshot
POST
Power Off Machine
PATCH
Update Machine
GET
Get Machine
DELETE
Delete Machine
POST
Suspend Machine
POST
Shutdown Machine
DELETE
Delete Machine Snapshot
POST
Power On Machine
POST
Reset Machine
POST
Revert Machine Snapshot