Skip to main content
POST
Create bare metal server

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.

Example:

1

Query Parameters

dry_run
boolean
default:false

Run every check of the real request and change nothing. The response has the status code and the schema of the real call, and an empty list of tasks. With false, the default, the request does the operation.

Body

application/json
flavor_name
string
required

Name of a bare metal flavor. The flavor sets the CPU, the memory, the disks and the network cards of the server. GET /v1/projects/{project_id}/baremetal/flavors lists the flavors.

Example:

"bm2-hf-medium"

image_id
string<uuid4>
required

OS image to write to the server's local disk.

Example:

"2fa8c5b1-1234-4abc-9def-0123456789ab"

interfaces
BaremetalInterfaceCreateSerializer · object[]
required

Pre-created ports to attach, in NIC/boot order.

Minimum array length: 1
region_id
integer
required

Region to provision the server in.

Example:

7

name
string

Server name. Auto-generated if omitted.

Pattern: ^[a-zA-Z0-9][a-zA-Z 0-9._\-]{1,61}[a-zA-Z0-9._]$
Example:

"bm-1"

password
string<password>
write-only

Password of the default user. No response returns it. A Windows image needs a password. For a Windows image, the create checks these rules: the password has a minimum of 6 characters, it contains no word 'admin', and it contains 3 of these character types: digits, lowercase letters, uppercase letters, other characters. For a Linux image, the password enables SSH login with a password. Send password or user_data, not both.

Minimum string length: 1
ssh_key_id
string<uuid4>

ID of the SSH key to add to the default user.

Example:

"21b3c2d5-efe8-4367-99ff-86e1e060d27f"

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. Tag keys and values cannot contain characters from U+0080 to U+00FF. 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.

Example:
user_data
string

cloud-init user data (raw or base64). Windows: may be combined with password (password sets the Administrator account). Linux: mutually exclusive with password.

Minimum string length: 1

Response

Task IDs

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.
Example: