Skip to main content
POST
/
cloud
/
v1
/
bminstances
/
{project_id}
/
{region_id}
Python
import os
from gcore import Gcore

client = Gcore(
    api_key=os.environ.get("GCORE_API_KEY"),  # This is the default and can be omitted
)
task_id_list = client.cloud.baremetal.servers.create(
    project_id=1,
    region_id=1,
    flavor="bm2-hf-medium",
    interfaces=[{
        "type": "external"
    }],
)
print(task_id_list.tasks)
{
  "tasks": [
    "<string>"
  ]
}

Authorizations

​
Authorization
string
header
required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Path Parameters

​
project_id
integer
required

Project ID Project ID

​
region_id
integer
required

Region ID Region ID

Body

application/json
​
flavor
string
required

The flavor of the instance.

​
interfaces
(CreateBareMetalExternalInterfaceSerializer · object | CreateBareMetalSubnetInterfaceSerializer · object | CreateBareMetalAnySubnetInterfaceSerializer · object | CreateBareMetalReservedFixedIpInterfaceSerializer · object)[]
required

A list of network interfaces for the server. You can create one or more interfaces - private, public, or both.

Minimum array length: 1

Instance will be attached to default external network

  • CreateBareMetalExternalInterfaceSerializer
  • CreateBareMetalSubnetInterfaceSerializer
  • CreateBareMetalAnySubnetInterfaceSerializer
  • CreateBareMetalReservedFixedIpInterfaceSerializer
Example:
{
  "interface_name": "eth0",
  "ip_family": "ipv4",
  "type": "external"
}
​
app_config
App Config · object

Parameters for the application template if creating the instance from an apptemplate.

​
apptemplate_id
string

Apptemplate ID. Either image_id or apptemplate_id is required.

​
ddos_profile
BaseCreateClientProfileSerializer · object

Enable advanced DDoS protection for the server

​
image_id
string<uuid4>

Image ID. Either image_id or apptemplate_id is required.

​
name
string

Server name.

​
name_template
string

If you want server names to be automatically generated based on IP addresses, you can provide a name template instead of specifying the name manually. The template should include a placeholder that will be replaced during provisioning. Supported placeholders are: {ip_octets} (last 3 octets of the IP), {two_ip_octets}, and {one_ip_octet}.

​
password
string

For Linux instances, 'username' and 'password' are used to create a new user. When only 'password' is provided, it is set as the password for the default user of the image. For Windows instances, 'username' cannot be specified. Use the 'password' field to set the password for the 'Admin' user on Windows. Use the 'user_data' field to provide a script to create new users on Windows. The password of the Admin user cannot be updated via 'user_data'.

​
ssh_key_name
string | null

Specifies the name of the SSH keypair, created via the /v1/ssh_keys endpoint.

Example:

"my-ssh-key"

​
tags
CreateTagsSerializer · object

Key-value tags to associate with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Both tag keys and values have a maximum length of 255 characters. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.

​
user_data
string

String in base64 format. For Linux instances, 'user_data' is ignored when 'password' field is provided. For Windows instances, Admin user password is set by 'password' field and cannot be updated via 'user_data'. Examples of the user_data: https://cloudinit.readthedocs.io/en/latest/topics/examples.html

​
username
string

For Linux instances, 'username' and 'password' are used to create a new user. For Windows instances, 'username' cannot be specified. Use 'password' field to set the password for the 'Admin' user on Windows.

Response

200 - application/json

OK

​
tasks
string[]
required

List of task IDs representing asynchronous operations. Use these IDs to monitor operation progress:

  • GET /v1/tasks/{task_id} - Check individual task status and details Poll task status until completion (FINISHED/ERROR) before proceeding with dependent operations.