Elastic Metal allow you to order dedicated servers on-demand, like cloud Instances. A server refers to physical server used to provide the service.
Create multiple Elastic Metal servers
Create multiple new Elastic Metal servers. Once the servers are created, proceed with the installation of an OS.
path Parameters
zoneThe zone you want to target
Create multiple Elastic Metal servers › Request Body
Configuration wanted for the servers to create.
List of servers to create.
Create multiple Elastic Metal servers › Responses
List Elastic Metal servers for an Organization
List Elastic Metal servers for a specific Organization.
path Parameters
zoneThe zone you want to target
query Parameters
pagePage number.
page_sizeNumber of servers per page.
order_byOrder of the servers.
tagsTags to filter for.
statusStatus to filter for.
nameNames to filter for.
organization_idOrganization ID to filter for.
project_idProject ID to filter for.
option_idOption ID to filter for.
List Elastic Metal servers for an Organization › Responses
total_countTotal count of matching servers.
Array of Elastic Metal server objects matching the filters in the request.
Create an Elastic Metal server
Create a new Elastic Metal server. Once the server is created, proceed with the installation of an OS.
path Parameters
zoneThe zone you want to target
Create an Elastic Metal server › Request Body
offer_idOffer ID of the new server.
nameName of the server (≠hostname).
descriptionDescription associated with the server, max 255 characters.
project_idProject ID with which the server will be created.
tagsTags to associate to the server.
Object describing the configuration details of the OS installation on the server.
option_idsIDs of options to enable on server.
protectedIf enabled, the server can not be deleted.
Configuration data to pass to cloud-init such as a YAML cloud config data or a user-data script.
organization_idOrganization ID with which the server will be created.
Create an Elastic Metal server › Responses
idID of the server.
organization_idOrganization ID the server is attached to.
project_idProject ID the server is attached to.
nameName of the server.
descriptionDescription of the server.
updated_atLast modification date of the server. (RFC 3339 format)
created_atCreation date of the server. (RFC 3339 format)
statusStatus of the server.
offer_idOffer ID of the server.
offer_nameOffer name of the server.
tagsArray of custom tags attached to the server.
Array of IPs attached to the server.
domainDomain of the server.
boot_typeBoot type of the server.
zoneZone in which is the server located.
Configuration of the installation.
ping_statusStatus of server ping.
Options enabled on the server.
Configuration of rescue boot.
protectedIf enabled, the server can not be deleted.
Optional configuration data passed to cloud-init.
Get a specific Elastic Metal server
Get full details of an existing Elastic Metal server associated with the ID.
path Parameters
zoneThe zone you want to target
server_idID of the server.
Get a specific Elastic Metal server › Responses
idID of the server.
organization_idOrganization ID the server is attached to.
project_idProject ID the server is attached to.
nameName of the server.
descriptionDescription of the server.
updated_atLast modification date of the server. (RFC 3339 format)
created_atCreation date of the server. (RFC 3339 format)
statusStatus of the server.
offer_idOffer ID of the server.
offer_nameOffer name of the server.
tagsArray of custom tags attached to the server.
Array of IPs attached to the server.
domainDomain of the server.
boot_typeBoot type of the server.
zoneZone in which is the server located.
Configuration of the installation.
ping_statusStatus of server ping.
Options enabled on the server.
Configuration of rescue boot.
protectedIf enabled, the server can not be deleted.
Optional configuration data passed to cloud-init.
Delete an Elastic Metal server
Delete the server associated with the ID.
path Parameters
zoneThe zone you want to target
server_idID of the server to delete.
Delete an Elastic Metal server › Responses
idID of the server.
organization_idOrganization ID the server is attached to.
project_idProject ID the server is attached to.
nameName of the server.
descriptionDescription of the server.
updated_atLast modification date of the server. (RFC 3339 format)
created_atCreation date of the server. (RFC 3339 format)
statusStatus of the server.
offer_idOffer ID of the server.
offer_nameOffer name of the server.
tagsArray of custom tags attached to the server.
Array of IPs attached to the server.
domainDomain of the server.
boot_typeBoot type of the server.
zoneZone in which is the server located.
Configuration of the installation.
ping_statusStatus of server ping.
Options enabled on the server.
Configuration of rescue boot.
protectedIf enabled, the server can not be deleted.
Optional configuration data passed to cloud-init.
Update an Elastic Metal server
Update the server associated with the ID. You can update parameters such as the server's name, tags, description and protection flag. Any parameters left null in the request body are not updated.
path Parameters
zoneThe zone you want to target
server_idID of the server to update.
Update an Elastic Metal server › Request Body
nameName of the server (≠hostname), not updated if null.
descriptionDescription associated with the server, max 255 characters, not updated if null.
tagsTags associated with the server, not updated if null.
protectedIf enabled, the server can not be deleted.
Configuration data to pass to cloud-init such as a YAML cloud config data or a user-data script.
Update an Elastic Metal server › Responses
idID of the server.
organization_idOrganization ID the server is attached to.
project_idProject ID the server is attached to.
nameName of the server.
descriptionDescription of the server.
updated_atLast modification date of the server. (RFC 3339 format)
created_atCreation date of the server. (RFC 3339 format)
statusStatus of the server.
offer_idOffer ID of the server.
offer_nameOffer name of the server.
tagsArray of custom tags attached to the server.
Array of IPs attached to the server.
domainDomain of the server.
boot_typeBoot type of the server.
zoneZone in which is the server located.
Configuration of the installation.
ping_statusStatus of server ping.
Options enabled on the server.
Configuration of rescue boot.
protectedIf enabled, the server can not be deleted.
Optional configuration data passed to cloud-init.
List server events
List event (i.e. start/stop/reboot) associated to the server ID.
path Parameters
zoneThe zone you want to target
server_idID of the server events searched.
query Parameters
pagePage number.
page_sizeNumber of server events per page.
order_byOrder of the server events.
List server events › Responses
total_countTotal count of matching events.
Server events that match filters.
Install an Elastic Metal server
Install an Operating System (OS) on the Elastic Metal server with a specific ID.
path Parameters
zoneThe zone you want to target
server_idServer ID to install.
Install an Elastic Metal server › Request Body
os_idID of the OS to installation on the server.
hostnameHostname of the server.
ssh_key_idsSSH key IDs authorized on the server.
userUser used for the installation.
passwordPassword used for the installation.
service_userUser used for the service to install.
service_passwordPassword used for the service to install.
Partitioning schema.
Configuration data to pass to cloud-init such as a YAML cloud config data or a user-data script.
Install an Elastic Metal server › Responses
idID of the server.
organization_idOrganization ID the server is attached to.
project_idProject ID the server is attached to.
nameName of the server.
descriptionDescription of the server.
updated_atLast modification date of the server. (RFC 3339 format)
created_atCreation date of the server. (RFC 3339 format)
statusStatus of the server.
offer_idOffer ID of the server.
offer_nameOffer name of the server.
tagsArray of custom tags attached to the server.
Array of IPs attached to the server.
domainDomain of the server.
boot_typeBoot type of the server.
zoneZone in which is the server located.
Configuration of the installation.
ping_statusStatus of server ping.
Options enabled on the server.
Configuration of rescue boot.
protectedIf enabled, the server can not be deleted.
Optional configuration data passed to cloud-init.
Update IP
Configure the IP address associated with the server ID and IP ID. You can use this method to set a reverse DNS for an IP address.
path Parameters
zoneThe zone you want to target
server_idID of the server.
ip_idID of the IP to update.
Update IP › Responses
idID of the IP.
addressAddress of the IP. (IP address)
reverseReverse IP value.
versionVersion of IP (v4 or v6).
reverse_statusStatus of the reverse.
reverse_status_messageA message related to the reverse status, e.g. in case of an error.
Return server metrics
Get the ping status of the server associated with the ID.
path Parameters
zoneThe zone you want to target
server_idServer ID to get the metrics.
Return server metrics › Responses
Timeseries object representing pings on the server.
Migrate server offer
Migrate server with hourly offer to monthly offer.
path Parameters
zoneThe zone you want to target
server_idID of the server.
Migrate server offer › Responses
idID of the server.
organization_idOrganization ID the server is attached to.
project_idProject ID the server is attached to.
nameName of the server.
descriptionDescription of the server.
updated_atLast modification date of the server. (RFC 3339 format)
created_atCreation date of the server. (RFC 3339 format)
statusStatus of the server.
offer_idOffer ID of the server.
offer_nameOffer name of the server.
tagsArray of custom tags attached to the server.
Array of IPs attached to the server.
domainDomain of the server.
boot_typeBoot type of the server.
zoneZone in which is the server located.
Configuration of the installation.
ping_statusStatus of server ping.
Options enabled on the server.
Configuration of rescue boot.
protectedIf enabled, the server can not be deleted.
Optional configuration data passed to cloud-init.
Add server option
Add an option, such as Private Networks, to a specific server.
path Parameters
zoneThe zone you want to target
server_idID of the server.
option_idID of the option to add.
Add server option › Request Body
expires_atAuto expire the option after this date. (RFC 3339 format)
Add server option › Responses
idID of the server.
organization_idOrganization ID the server is attached to.
project_idProject ID the server is attached to.
nameName of the server.
descriptionDescription of the server.
updated_atLast modification date of the server. (RFC 3339 format)
created_atCreation date of the server. (RFC 3339 format)
statusStatus of the server.
offer_idOffer ID of the server.
offer_nameOffer name of the server.
tagsArray of custom tags attached to the server.
Array of IPs attached to the server.
domainDomain of the server.
boot_typeBoot type of the server.
zoneZone in which is the server located.
Configuration of the installation.
ping_statusStatus of server ping.
Options enabled on the server.
Configuration of rescue boot.
protectedIf enabled, the server can not be deleted.
Optional configuration data passed to cloud-init.
Delete server option
Delete an option from a specific server.
path Parameters
zoneThe zone you want to target
server_idID of the server.
option_idID of the option to delete.
Delete server option › Responses
idID of the server.
organization_idOrganization ID the server is attached to.
project_idProject ID the server is attached to.
nameName of the server.
descriptionDescription of the server.
updated_atLast modification date of the server. (RFC 3339 format)
created_atCreation date of the server. (RFC 3339 format)
statusStatus of the server.
offer_idOffer ID of the server.
offer_nameOffer name of the server.
tagsArray of custom tags attached to the server.
Array of IPs attached to the server.
domainDomain of the server.
boot_typeBoot type of the server.
zoneZone in which is the server located.
Configuration of the installation.
ping_statusStatus of server ping.
Options enabled on the server.
Configuration of rescue boot.
protectedIf enabled, the server can not be deleted.
Optional configuration data passed to cloud-init.