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

200

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

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/flexMetal/servers

GET /v3/flexMetal/servers?status=text HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "uuid": "019256ab-1554-73a7-b091-f024b0a724ea",
    "name": "host.example.com",
    "status": "delivered",
    "statusMessage": "OK",
    "location": {
      "id": 18,
      "name": "text"
    },
    "instanceType": {
      "id": 128,
      "name": "bm7.std.8"
    },
    "os": {
      "slug": "ubuntu-2404-lts"
    },
    "ipAddresses": [
      {
        "ipAddress": "1.2.3.4"
      }
    ],
    "tags": [
      "my-tag"
    ],
    "createdAt": 1728030905,
    "deliveredAt": 1728031748,
    "releasedAt": 1,
    "contractId": "MY-CONTRACT-123"
  }
]

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

200

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

400

Invalid request body

403

Invalid credentials

422

Unprocessable content

500

Internal Server Error

application/json

post

/v3/flexMetal/servers

POST /v3/flexMetal/servers HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 623

{
  "name": "host.example.com",
  "location": "text",
  "instanceType": "bm7.std.8",
  "os": {
    "slug": "ubuntu-2404-lts",
    "kernelParams": [
      {
        "key": "siderolink.api",
        "value": "url.to.omni"
      }
    ],
    "partitions": [
      {
        "target": "/custom",
        "filesystem": "ext4",
        "size": 10240
      }
    ],
    "ipxeScriptUrl": "https://example.org/custom-ipxe.cfg"
  },
  "sshKey": [
    "ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBHo8IaPkQ6UnDZvi4F4RBSouRa6Gtysdg2EF+SIXheVF2SGBQ2uH7RfDjXRfvq4VpHJrKYs4kWfNoHQg8ZG6PH4= ecdsa-key-20240131"
  ],
  "postInstallScript": "#!/bin/bash\necho \"Hello world!\" > /root/blah.txt",
  "tags": [
    "my-tag"
  ],
  "contractId": "MY-CONTRACT-123",
  "overflow": true
}

[
  {
    "uuid": "019256ab-1554-73a7-b091-f024b0a724ea",
    "name": "host.example.com",
    "status": "delivered",
    "statusMessage": "OK",
    "location": {
      "id": 18,
      "name": "text"
    },
    "instanceType": {
      "id": 128,
      "name": "bm7.std.8"
    },
    "os": {
      "slug": "ubuntu-2404-lts"
    },
    "ipAddresses": [
      {
        "ipAddress": "1.2.3.4"
      }
    ],
    "tags": [
      "my-tag"
    ],
    "createdAt": 1728030905,
    "deliveredAt": 1728031748,
    "releasedAt": 1,
    "contractId": "MY-CONTRACT-123"
  }
]

Get a specific FlexMetal server

get

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

uuidstringRequired

The server identifier

Responses

200

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

403

Invalid credentials

404

Resource not found

500

Internal Server Error

application/json

get

/v3/flexMetal/servers/{uuid}

GET /v3/flexMetal/servers/{uuid} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "uuid": "019256ab-1554-73a7-b091-f024b0a724ea",
    "name": "host.example.com",
    "status": "delivered",
    "statusMessage": "OK",
    "location": {
      "id": 18,
      "name": "text"
    },
    "instanceType": {
      "id": 128,
      "name": "bm7.std.8"
    },
    "os": {
      "slug": "ubuntu-2404-lts"
    },
    "ipAddresses": [
      {
        "ipAddress": "1.2.3.4"
      }
    ],
    "tags": [
      "my-tag"
    ],
    "createdAt": 1728030905,
    "deliveredAt": 1728031748,
    "releasedAt": 1,
    "contractId": "MY-CONTRACT-123"
  }
]

Release a FlexMetal server

delete

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

uuidstringRequired

The server identifier

Responses

200

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

403

Invalid credentials

404

Resource not found

500

Internal Server Error

application/json

delete

/v3/flexMetal/servers/{uuid}

DELETE /v3/flexMetal/servers/{uuid} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "uuid": "019256ab-1554-73a7-b091-f024b0a724ea",
    "name": "host.example.com",
    "status": "delivered",
    "statusMessage": "OK",
    "location": {
      "id": 18,
      "name": "text"
    },
    "instanceType": {
      "id": 128,
      "name": "bm7.std.8"
    },
    "os": {
      "slug": "ubuntu-2404-lts"
    },
    "ipAddresses": [
      {
        "ipAddress": "1.2.3.4"
      }
    ],
    "tags": [
      "my-tag"
    ],
    "createdAt": 1728030905,
    "deliveredAt": 1728031748,
    "releasedAt": 1,
    "contractId": "MY-CONTRACT-123"
  }
]

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

200

application/json

rootPasswordstringRequired

Server root password.

403

Invalid credentials

404

Resource not found

500

Internal Server Error

application/json

get

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

GET /v3/flexMetal/servers/{uuid}/rootPassword HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "rootPassword": "text"
  }
]

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

200

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

403

Invalid credentials

404

Resource not found

500

Internal Server Error

application/json

post

/v3/flexMetal/servers/{uuid}/tag/{tag}

POST /v3/flexMetal/servers/{uuid}/tag/{tag} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "uuid": "019256ab-1554-73a7-b091-f024b0a724ea",
    "name": "host.example.com",
    "status": "delivered",
    "statusMessage": "OK",
    "location": {
      "id": 18,
      "name": "text"
    },
    "instanceType": {
      "id": 128,
      "name": "bm7.std.8"
    },
    "os": {
      "slug": "ubuntu-2404-lts"
    },
    "ipAddresses": [
      {
        "ipAddress": "1.2.3.4"
      }
    ],
    "tags": [
      "my-tag"
    ],
    "createdAt": 1728030905,
    "deliveredAt": 1728031748,
    "releasedAt": 1,
    "contractId": "MY-CONTRACT-123"
  }
]

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

200

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

403

Invalid credentials

404

Resource not found

500

Internal Server Error

application/json

delete

/v3/flexMetal/servers/{uuid}/tag/{tag}

DELETE /v3/flexMetal/servers/{uuid}/tag/{tag} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "uuid": "019256ab-1554-73a7-b091-f024b0a724ea",
    "name": "host.example.com",
    "status": "delivered",
    "statusMessage": "OK",
    "location": {
      "id": 18,
      "name": "text"
    },
    "instanceType": {
      "id": 128,
      "name": "bm7.std.8"
    },
    "os": {
      "slug": "ubuntu-2404-lts"
    },
    "ipAddresses": [
      {
        "ipAddress": "1.2.3.4"
      }
    ],
    "tags": [
      "my-tag"
    ],
    "createdAt": 1728030905,
    "deliveredAt": 1728031748,
    "releasedAt": 1,
    "contractId": "MY-CONTRACT-123"
  }
]

Get your FlexMetal capacity commits and usage

get

Authorizations

PRIVATE-TOKENstringRequired

Responses

200

application/json

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/flexMetal/capacity/commit

GET /v3/flexMetal/capacity/commit HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "location": {
      "id": 1,
      "name": "text",
      "shortName": "text",
      "displayName": "text",
      "countryId": 1,
      "countryName": "text",
      "countryShortName": "text"
    },
    "commits": [
      {
        "instanceType": {
          "id": 1,
          "locationId": 1,
          "name": "text",
          "sockets": 1,
          "cores": 1,
          "memory": 1,
          "memoryType": "text",
          "storage": 1,
          "storageType": "text",
          "generationName": "text"
        },
        "capacity": 1,
        "inUse": 1
      }
    ]
  }
]

Get all available Bare Metal locations

get

Authorizations

PRIVATE-TOKENstringRequired

Responses

200

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

500

Internal Server Error

application/json

get

/v3/flexMetal/location

GET /v3/flexMetal/location HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "name": "text",
    "shortName": "text",
    "displayName": "text",
    "countryId": 1,
    "countryName": "text",
    "countryShortName": "text"
  }
]

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

200

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

500

Internal Server Error

application/json

get

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

GET /v3/flexMetal/location/{locationId}/instanceTypes HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "locationId": 1,
    "name": "text",
    "sockets": 1,
    "cores": 1,
    "memory": 1,
    "memoryType": "text",
    "storage": 1,
    "storageType": "text",
    "generationName": "text"
  }
]

Last updated 2 months ago

Was this helpful?

hashtagGet all your FlexMetal servers

hashtagCreate a new FlexMetal server

hashtagGet a specific FlexMetal server

hashtagRelease a FlexMetal server

hashtagGet a FlexMetal server's root password

hashtagAdd a tag to a FlexMetal server

hashtagRemove a tag from a FlexMetal server

hashtagGet your FlexMetal capacity commits and usage

hashtagGet all available Bare Metal locations

hashtagGet all instance types for a location.

Get all your FlexMetal servers

Create a new FlexMetal server

Get a specific FlexMetal server

Release a FlexMetal server

Get a FlexMetal server's root password

Add a tag to a FlexMetal server

Remove a tag from a FlexMetal server

Get your FlexMetal capacity commits and usage

Get all available Bare Metal locations

Get all instance types for a location.