HomeGuidesAPI Reference
CommunityWebsiteDocumentationExchangeSupportDeveloper
API Reference

Create an Instance

Create an Instance

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
instance
object
required

Key for name, site, instanceType layout, and plan.

int64

The Cloud ID to provision the instance onto.

evars
array of objects

Environment Variables, an array of objects that have name and value.

evars
int64
Defaults to 1

Number of copies to provision.

int64
Defaults to 1

Apply a multiply factor of containers/vms within the instance.

servicePlanOptions
object

Map of custom options depending on selected service plan.

securityGroups
array of objects | null

Key for security group configuration. It should be passed as an array of objects containing the id of the security group to assign the instance to.

securityGroups
volumes
array of objects

The (optional) volumes parameter is for LV configuration, can create additional LVs at provision It should be passed as an array of

volumes
networkInterfaces
array of objects

The networkInterfaces parameter is for network configuration.

The Options API /api/options/zoneNetworkOptions?zoneId=5&provisionTypeId=10 can be used to see which options are available.

networkInterfaces
config
required
labels
array of strings

Array of strings (keywords).

labels
tags
array of objects

Metadata tags, Array of objects having a name and value.

tags
metadata
array of objects

Alias for tags.

metadata
ports
array of objects

The ports parameter is for port configuration.

The layout may have default ports, which are defined in node types, that are always configured. This parameter will be for additional custom ports to be opened.

ports
int64

The Workflow ID to execute.

string

The Workflow Name to execute.

serverUUIDs
array of strings

Server UUIDs is an optional array of uuid string values to assign to the new servers being provisioned for this instance.

serverUUIDs
Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json