FlexMetalServer

FlexMetal servers are physical servers that can be requested and released at will.

Get all your FlexMetal servers

get
Authorizations
PRIVATE-TOKENstringRequired
Query parameters
statusstringRequired

Filter by status [creating, provisioning, delivered, failed, releasing, released]

taganyRequired

Filter by one or more server tags (only servers with all tags will be returned)

Header parameters
RANGED-DATAstringOptional

Example header and default range: RANGED-DATA:start=0,results=25

Responses
chevron-right
200

OK

application/json
uuidstringRead-onlyRequired

Server UUID.

Example: 019256ab-1554-73a7-b091-f024b0a724ea
namestringRequired

Server host name.

Example: host.example.com
statusstringRead-onlyRequired

Server delivery status.createddiscoveringdiscoveredallocatingallocatedconfiguring_networknetwork_configuredprovisioningprovisioneddeliveredfailedreleasingreleased

Example: delivered
statusMessagestringRead-onlyRequired

Status message.

Example: OK
tagsstring[]Read-onlyRequired

Server tags.

Example: my-tag
createdAtinteger · integerRead-onlyRequired

Server creation timestamp.

Example: 1728030905
deliveredAtinteger · integerRead-onlyRequired

Server delivery timestamp.

Example: 1728031748
releasedAtinteger · integerRead-onlyRequired

Server release timestamp.

contractIdstringRead-onlyRequired

Represents client contractId.

Example: MY-CONTRACT-123
get
/v3/flexMetal/servers

Create a new FlexMetal server

post
Authorizations
PRIVATE-TOKENstringRequired
Body

Request object for creating a new Flex Metal server

namestringRequired

Server name or hostname, depending on the chosen OS. E.g. Talos requires a hostname but regular Linux OSs work with either.

Example: host.example.com
locationstringRequired

Server location. Available locations can be obtained from /v3/flexMetal/location. Use the name field from the response.

instanceTypestringRequired

Server instance type. Available instance types can be obtained from /v3/flexMetal/location/{locationId}}/instanceTypes. Use the name field from the response.

Example: bm7.std.8
sshKeystring[]Required

A list of SSH keys. You can either supply SSH key UUIDs from stored objects in /v3/sshKey or provide public keys directly. SSH keys are installed for the root user.

Example: ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBHo8IaPkQ6UnDZvi4F4RBSouRa6Gtysdg2EF+SIXheVF2SGBQ2uH7RfDjXRfvq4VpHJrKYs4kWfNoHQg8ZG6PH4= ecdsa-key-20240131
postInstallScriptstringOptional

Post install script. A shell script (e.g. bash) that will be executed after your OS is installed. Currently only supported for Linux based operating systems.

Example: #!/bin/bash echo "Hello world!" > /root/blah.txt
tagsstring[]Optional

A list of tags. There is a maximum of 60 tags per server. Each tag must adhere to this pattern: ^[A-Za-z0-9_:-]{1,64}$

Example: my-tag
contractIdstringOptional

Represents client contractId. Format is ^[A-Z0-9_-.]{0,240}$

Example: MY-CONTRACT-123
overflowbooleanOptional

If true, the server will be created even if the location is at commited capacity. Default is false.

Example: true
Responses
chevron-right
200

OK

application/json
uuidstringRead-onlyRequired

Server UUID.

Example: 019256ab-1554-73a7-b091-f024b0a724ea
namestringRequired

Server host name.

Example: host.example.com
statusstringRead-onlyRequired

Server delivery status.createddiscoveringdiscoveredallocatingallocatedconfiguring_networknetwork_configuredprovisioningprovisioneddeliveredfailedreleasingreleased

Example: delivered
statusMessagestringRead-onlyRequired

Status message.

Example: OK
tagsstring[]Read-onlyRequired

Server tags.

Example: my-tag
createdAtinteger · integerRead-onlyRequired

Server creation timestamp.

Example: 1728030905
deliveredAtinteger · integerRead-onlyRequired

Server delivery timestamp.

Example: 1728031748
releasedAtinteger · integerRead-onlyRequired

Server release timestamp.

contractIdstringRead-onlyRequired

Represents client contractId.

Example: MY-CONTRACT-123
post
/v3/flexMetal/servers

Get a specific FlexMetal server

get
Authorizations
PRIVATE-TOKENstringRequired
Path parameters
uuidstringRequired

The server identifier

Responses
chevron-right
200

OK

application/json
uuidstringRead-onlyRequired

Server UUID.

Example: 019256ab-1554-73a7-b091-f024b0a724ea
namestringRequired

Server host name.

Example: host.example.com
statusstringRead-onlyRequired

Server delivery status.createddiscoveringdiscoveredallocatingallocatedconfiguring_networknetwork_configuredprovisioningprovisioneddeliveredfailedreleasingreleased

Example: delivered
statusMessagestringRead-onlyRequired

Status message.

Example: OK
tagsstring[]Read-onlyRequired

Server tags.

Example: my-tag
createdAtinteger · integerRead-onlyRequired

Server creation timestamp.

Example: 1728030905
deliveredAtinteger · integerRead-onlyRequired

Server delivery timestamp.

Example: 1728031748
releasedAtinteger · integerRead-onlyRequired

Server release timestamp.

contractIdstringRead-onlyRequired

Represents client contractId.

Example: MY-CONTRACT-123
get
/v3/flexMetal/servers/{uuid}

Release a FlexMetal server

delete
Authorizations
PRIVATE-TOKENstringRequired
Path parameters
uuidstringRequired

The server identifier

Responses
chevron-right
200

OK

application/json
uuidstringRead-onlyRequired

Server UUID.

Example: 019256ab-1554-73a7-b091-f024b0a724ea
namestringRequired

Server host name.

Example: host.example.com
statusstringRead-onlyRequired

Server delivery status.createddiscoveringdiscoveredallocatingallocatedconfiguring_networknetwork_configuredprovisioningprovisioneddeliveredfailedreleasingreleased

Example: delivered
statusMessagestringRead-onlyRequired

Status message.

Example: OK
tagsstring[]Read-onlyRequired

Server tags.

Example: my-tag
createdAtinteger · integerRead-onlyRequired

Server creation timestamp.

Example: 1728030905
deliveredAtinteger · integerRead-onlyRequired

Server delivery timestamp.

Example: 1728031748
releasedAtinteger · integerRead-onlyRequired

Server release timestamp.

contractIdstringRead-onlyRequired

Represents client contractId.

Example: MY-CONTRACT-123
delete
/v3/flexMetal/servers/{uuid}

Get a FlexMetal server's root password

get

Windows only: Fetch the root password within the first 24 hours after installation.

Authorizations
PRIVATE-TOKENstringRequired
Path parameters
uuidstringRequired

The server identifier

Responses
chevron-right
200

OK

application/json
rootPasswordstringRequired

Server root password.

get
/v3/flexMetal/servers/{uuid}/rootPassword

Add a tag to a FlexMetal server

post
Authorizations
PRIVATE-TOKENstringRequired
Path parameters
uuidstringRequired

The server identifier

tagstringRequired

The tag to add to the server

Responses
chevron-right
200

OK

application/json
uuidstringRead-onlyRequired

Server UUID.

Example: 019256ab-1554-73a7-b091-f024b0a724ea
namestringRequired

Server host name.

Example: host.example.com
statusstringRead-onlyRequired

Server delivery status.createddiscoveringdiscoveredallocatingallocatedconfiguring_networknetwork_configuredprovisioningprovisioneddeliveredfailedreleasingreleased

Example: delivered
statusMessagestringRead-onlyRequired

Status message.

Example: OK
tagsstring[]Read-onlyRequired

Server tags.

Example: my-tag
createdAtinteger · integerRead-onlyRequired

Server creation timestamp.

Example: 1728030905
deliveredAtinteger · integerRead-onlyRequired

Server delivery timestamp.

Example: 1728031748
releasedAtinteger · integerRead-onlyRequired

Server release timestamp.

contractIdstringRead-onlyRequired

Represents client contractId.

Example: MY-CONTRACT-123
post
/v3/flexMetal/servers/{uuid}/tag/{tag}

Remove a tag from a FlexMetal server

delete
Authorizations
PRIVATE-TOKENstringRequired
Path parameters
uuidstringRequired

The server identifier

tagstringRequired

The tag to remove from the server

Responses
chevron-right
200

OK

application/json
uuidstringRead-onlyRequired

Server UUID.

Example: 019256ab-1554-73a7-b091-f024b0a724ea
namestringRequired

Server host name.

Example: host.example.com
statusstringRead-onlyRequired

Server delivery status.createddiscoveringdiscoveredallocatingallocatedconfiguring_networknetwork_configuredprovisioningprovisioneddeliveredfailedreleasingreleased

Example: delivered
statusMessagestringRead-onlyRequired

Status message.

Example: OK
tagsstring[]Read-onlyRequired

Server tags.

Example: my-tag
createdAtinteger · integerRead-onlyRequired

Server creation timestamp.

Example: 1728030905
deliveredAtinteger · integerRead-onlyRequired

Server delivery timestamp.

Example: 1728031748
releasedAtinteger · integerRead-onlyRequired

Server release timestamp.

contractIdstringRead-onlyRequired

Represents client contractId.

Example: MY-CONTRACT-123
delete
/v3/flexMetal/servers/{uuid}/tag/{tag}

Get your FlexMetal capacity commits and usage

get
Authorizations
PRIVATE-TOKENstringRequired
Responses
chevron-right
200

OK

application/json
get
/v3/flexMetal/capacity/commit

Get all available Bare Metal locations

get
Authorizations
PRIVATE-TOKENstringRequired
Responses
chevron-right
200

OK

application/json
idinteger · integerRead-onlyRequired

ID of the location

namestringRead-onlyRequired

Name of the location

shortNamestringRead-onlyRequired

Short name of the location

displayNamestringRead-onlyRequired

Display name of the location

countryIdinteger · integerRead-onlyRequired

Country ID of the location

countryNamestringRead-onlyRequired

Country name of the Location

countryShortNamestringRead-onlyRequired

Country short name of the Location

get
/v3/flexMetal/location

Get all instance types for a location.

get

For an overview of all locations, see /v3/flexMetal/location

Authorizations
PRIVATE-TOKENstringRequired
Path parameters
locationIdintegerRequired
Responses
chevron-right
200

OK

application/json
idinteger · integerRead-onlyRequired

Id of instance type

locationIdinteger · integerRead-onlyRequired

LocationId of instance type

namestringRead-onlyRequired

Name of instance type

socketsinteger · integerRead-onlyRequired

Sockets of instance type

coresinteger · integerRead-onlyRequired

Cores of instance type

memoryinteger · integerRead-onlyRequired

Memory of instance type

memoryTypestringRead-onlyRequired

Memory type of instance type

storageinteger · integerRead-onlyRequired

Storage of instance type

storageTypestringRead-onlyRequired

Storage type of instance type

generationNamestringRead-onlyRequired

Generation name of instance type

get
/v3/flexMetal/location/{locationId}/instanceTypes

Last updated

Was this helpful?