OpenMetal API (1.0.0)

Exchange OAuth Application client credentials for a short-lived Bearer token.

This endpoint uses Basic Authentication with your OAuth App credentials:

• Username: client_id
• Password: client_secret

The Authorization header should contain the Base64-encoded credentials in the format:

Authorization: Basic <Base64(client_id:client_secret)>

Example cURL request:

curl --location 'https://api.central.openmetal.io/v1/oauth2/token?grant_type=client_credentials' \
  --header 'Authorization: Basic <Base64-encoded-credentials>'

Retrieve a list of of your clouds.

Retrieve details of a specific cloud by their ID.

Delete a cloud resource and reclaim all associated infrastructure. If a cloud is > 60 minutes old, a deletion request will generate a confirmation code that is sent to the account owner's email for verification. This code must be provided as a query parameter to complete the deletion.

Important: The cloud will be immediately deactivated upon successful deletion. However, there is a 3-day delay before servers are fully decommissioned and wiped. Clouds will enter a "pending-delete" state during this period.

Get hardware information for a specific cloud. This includes current power state of all nodes.

Assign an existing VLAN resource to a private cloud.

Requirements:

• Both the cloud and VLAN must be in the same datacenter location
• Both resources must be owned by the same organization
• The cloud provisioning status must be "complete"
• Clouds can have a maximum of 10 assigned VLANs

Unassign a VLAN resource from a private cloud.

This removes the association between the VLAN and the cloud but does not delete the VLAN resource itself.

Important: You cannot remove all VLAN assignments. A VLAN needs to have at least one cloud assignment.

Change power state. Options are "power on", "power off", or "rebooting".

Generates an IPMI (Intelligent Platform Management Interface) console session and retrieves a URL for accessing the HTML5-based web console for remote management of a node. This provides browser-based KVM access for server remote management without requiring Java or additional software installation.

Recommended Method: The HTML5 console is the recommended method for accessing IPMI as it works directly in modern web browsers.

For help using the web console, see Accessing IPMI on Central Dashboard.

Generates an IPMI (Intelligent Platform Management Interface) console session and downloads a Java Network Launch Protocol (JNLP) file for launching a Java-based KVM console to access a node's remote management interface.

Prerequisites:

• Java Runtime Environment (JRE) must be installed on the client machine
• Download available from www.java.com/en/download

Usage: Once downloaded, the JNLP file can be launched with Java Web Start to open the KVM console.

For additional assistance, visit the IPMI KVM documentation.

Retrieve a list of available operating system images for node deployment at a specific pod location. This endpoint does not require authentication.

Retrieve a list of available datacenter locations and their details.

Retrieve current inventory availability information for a specific datacenter location. This endpoint shows available hardware SKUs and their counts.

Retrieve a catalog of available OpenMetal cloud products including hardware configurations and addon services.

This is a public endpoint that provides the complete product catalog, including:

• Hardware products grouped by type (Small, Medium, Large, etc.)
• Addon services categorized by functionality (memory, storage, ip_block, other)
• Pricing information for all products and addons
• Hardware specifications and capabilities

Note: This endpoint is publicly accessible and does not require authentication.

Retrieve a list of all orders that have been created by you or organizations that you are a member of.

Retrieve a specific order by its ID to view details and check the status of the order.

Create a new order for baremetal servers or private cloud products running OpenStack.

Retrieve a list of all VLAN resources that have been created by you or organizations that you are a member of.

Retrieve details of a specific VLAN resource by its ID.

Update an existing VLAN resource.

Note: Only user-created VLANs can be modified. System-reserved VLANs (control, compute, storage, tunnel, octavia, inventory, provider) cannot be altered.

Create a new VLAN resource in a specified datacenter location.

VLANs can optionally be assigned to a cloud and/or have an IP Address Block assigned during creation.

Assign an existing IP Address Block (prefix) resource to a VLAN.

Requirements:

• Both resources must be in the same datacenter location
• Both resources must be owned by the same organization
• The IP Address Block must not already be assigned to another VLAN

Retrieve a list of all IP Address Block (prefix) resources that have been created by you or organizations that you are a member of.

IP Address Blocks are network prefixes (CIDR blocks) used for IP address allocation in private clouds.

Retrieve details of a specific IP Address Block resource by its ID.

Update an existing IP Address Block resource.

Create a new IP Address Block (network prefix) resource in a specified datacenter location.

IP Address Blocks can be created with a specific CIDR or by specifying a prefix length to automatically allocate from available address space.

Important: An IP Address Block must be assigned to a VLAN for use. Create the appropriate internal or routed VLAN to assign this IP Address Block to. IP Blocks can be assigned to a VLAN during IP Block creation (via central_vlan_id) or after creation in a separate request.