FlexMetal

OpenAPI documentation for the i3D.net FlexMetal API.

For setup, prerequisites, Terraform usage and other narrative, see Getting started with FlexMetal.

Locations and Plans

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"
  }
]

Deprecated

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"
  }
]

Get the server availability plan

get

Authorizations

PRIVATE-TOKENstringRequired

Responses

200

application/json

namestringRead-onlyRequired

The name of this plan, also referred to as the instance type name.

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/flexMetal/plans

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

[
  {
    "name": "text",
    "hardwareDetails": {
      "cpu": {
        "name": "text",
        "baseClock": 1,
        "cpuCount": 1,
        "cpuCores": 1,
        "totalCores": 1
      },
      "memory": {
        "type": "text",
        "size": 1
      },
      "disks": [
        {
          "type": "text",
          "size": 1
        }
      ],
      "networkInterfaces": [
        {
          "type": "text",
          "count": 1
        }
      ],
      "gpu": {
        "name": "text",
        "vram": 1
      }
    },
    "locations": [
      {
        "name": "text",
        "dcCode": "text",
        "availability": "text"
      }
    ]
  }
]

Servers

Get all your FlexMetal servers

get

Authorizations

PRIVATE-TOKENstringRequired

Query parameters

statusstringRequired

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

tagstring[]Required

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.

created

delivered

failed

releasing

released

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 · integerOptional

Server delivery timestamp.

Example: 1728031748

releasedAtinteger · integerOptional

Server release timestamp.

contractIdstringOptional

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&tag=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.

created

delivered

failed

releasing

released

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 · integerOptional

Server delivery timestamp.

Example: 1728031748

releasedAtinteger · integerOptional

Server release timestamp.

contractIdstringOptional

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: 651

{
  "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": "text"
  },
  "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,
  "userData": {
    "data": "my custom user data",
    "isBase64": false
  }
}

[
  {
    "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.

created

delivered

failed

releasing

released

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 · integerOptional

Server delivery timestamp.

Example: 1728031748

releasedAtinteger · integerOptional

Server release timestamp.

contractIdstringOptional

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"
  }
]

Re-install a specific FlexMetal server

patch

Important note: When wipeDisk is true (the default), this will cause a full disk wipe!

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

uuidstringRequired

The server identifier

Query parameters

wipeDiskbooleanOptional

When false, skips the explicit quick-format pre-step. Defaults to true.

Default: true

Body

namestringOptional

Server host name.

Example: host.example.com

sshKeystring[]Optional

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

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.

created

delivered

failed

releasing

released

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 · integerOptional

Server delivery timestamp.

Example: 1728031748

releasedAtinteger · integerOptional

Server release timestamp.

contractIdstringOptional

Represents client contractId.

Example: MY-CONTRACT-123

403

Invalid credentials

404

Resource not found

500

Internal Server Error

application/json

patch

/v3/flexMetal/servers/{uuid}

PATCH /v3/flexMetal/servers/{uuid} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 541

{
  "name": "host.example.com",
  "os": {
    "slug": "ubuntu-2404-lts",
    "kernelParams": [
      {
        "key": "siderolink.api",
        "value": "url.to.omni"
      }
    ],
    "partitions": [
      {
        "target": "/custom",
        "filesystem": "ext4",
        "size": 10240
      }
    ],
    "ipxeScriptUrl": "text"
  },
  "sshKey": [
    "ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBHo8IaPkQ6UnDZvi4F4RBSouRa6Gtysdg2EF+SIXheVF2SGBQ2uH7RfDjXRfvq4VpHJrKYs4kWfNoHQg8ZG6PH4= ecdsa-key-20240131"
  ],
  "postInstallScript": "#!/bin/bash\necho \"Hello world!\" > /root/blah.txt",
  "userData": {
    "data": "my custom user data",
    "isBase64": false
  }
}

[
  {
    "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.

created

delivered

failed

releasing

released

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 · integerOptional

Server delivery timestamp.

Example: 1728031748

releasedAtinteger · integerOptional

Server release timestamp.

contractIdstringOptional

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 the LSHW output of a specific FlexMetal server

get

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

uuidstringRequired

The server identifier

Responses

200

application/json

A Flex Metal server's LSHW output

createdAtinteger · integerRequired

The unixtimestamp of when the LSHW output was generated on the server. 0 if there is no known LSHW output.

Example: 1734443654

lshwobjectRequired

The server's LSHW output or null if there is no known LSHW output.

403

Invalid credentials

404

Resource not found

500

Internal Server Error

application/json

get

/v3/flexMetal/servers/{uuid}/lshw

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

[
  {
    "createdAt": "1734443654",
    "lshw": {}
  }
]

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"
  }
]

Server commands

Get all your server commands for the given server UUID

get

Authorizations

PRIVATE-TOKENstringRequired

Header parameters

RANGED-DATAstringOptional

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

Responses

200

application/json

A FlexMetal server command

uuidstringRead-onlyRequired

Server command UUID.

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

serverUuidstringRead-onlyRequired

Server UUID.

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

statestringRead-onlyRequired

Server command state.

finished

failed

Example: finished

createdAtstringRead-onlyRequired

created at server command timestamp.

updatedAtstringRead-onlyRequired

updated at server command timestamp.

403

Invalid credentials

404

Server commands could not be found for given server UUID

422

Unprocessable entity

500

Internal Server Error

application/json

get

/v3/flexMetal/servers/{uuid}/commands

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

[
  {
    "uuid": "019256ab-1554-73a7-b091-f024b0a724ea",
    "serverUuid": "019256ab-1554-73a7-b091-f024b0a724ea",
    "payload": {
      "command": "reboot|power_on|power_off|shutdown"
    },
    "state": "finished",
    "createdAt": "text",
    "updatedAt": "text"
  }
]

Create a new server command

post

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

uuidstringRequired

The server identifier

Body

Request object for creating a server command

commandstringRequired

Server command to be executed.

Example: reboot|power_on|power_off|shutdown

Responses

200

application/json

A FlexMetal server command

uuidstringRead-onlyRequired

Server command UUID.

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

serverUuidstringRead-onlyRequired

Server UUID.

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

statestringRead-onlyRequired

Server command state.

finished

failed

Example: finished

createdAtstringRead-onlyRequired

created at server command timestamp.

updatedAtstringRead-onlyRequired

updated at server command timestamp.

400

Invalid request body

403

Invalid credentials

422

Unprocessable content

500

Internal Server Error

application/json

post

/v3/flexMetal/servers/{uuid}/commands

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

{
  "command": "reboot|power_on|power_off|shutdown"
}

{
  "uuid": "019256ab-1554-73a7-b091-f024b0a724ea",
  "serverUuid": "019256ab-1554-73a7-b091-f024b0a724ea",
  "payload": {
    "command": "reboot|power_on|power_off|shutdown"
  },
  "state": "finished",
  "createdAt": "text",
  "updatedAt": "text"
}

Get a specific server command by UUID

get

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

uuidstringRequired

The server identifier

commandUuidstringRequired

The server command identifier

Responses

200

application/json

A FlexMetal server command

uuidstringRead-onlyRequired

Server command UUID.

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

serverUuidstringRead-onlyRequired

Server UUID.

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

statestringRead-onlyRequired

Server command state.

finished

failed

Example: finished

createdAtstringRead-onlyRequired

created at server command timestamp.

updatedAtstringRead-onlyRequired

updated at server command timestamp.

403

Invalid credentials

404

Resource not found

500

Internal Server Error

application/json

get

/v3/flexMetal/servers/{uuid}/commands/{commandUuid}

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

[
  {
    "uuid": "019256ab-1554-73a7-b091-f024b0a724ea",
    "serverUuid": "019256ab-1554-73a7-b091-f024b0a724ea",
    "payload": {
      "command": "reboot|power_on|power_off|shutdown"
    },
    "state": "finished",
    "createdAt": "text",
    "updatedAt": "text"
  }
]

Tags

Get all your FlexMetal tags

get

Authorizations

PRIVATE-TOKENstringRequired

Header parameters

RANGED-DATAstringOptional

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

Responses

200

List of tags

application/json

A Flex Metal tag

tagstringRequired

The tag name

Example: my-tag

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/flexMetal/tags

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

[
  {
    "tag": "my-tag",
    "resources": {
      "count": 1,
      "flexMetalServers": {
        "count": 1
      }
    }
  }
]

Create a FlexMetal tag

post

Authorizations

PRIVATE-TOKENstringRequired

Body

A Flex Metal tag

tagstringRequired

The tag name

Example: my-tag

Responses

200

The new tag

application/json

A Flex Metal tag

tagstringRequired

The tag name

Example: my-tag

403

Invalid credentials

422

Unprocessable content

500

Internal Server Error

application/json

post

/v3/flexMetal/tags

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

{
  "tag": "my-tag"
}

[
  {
    "tag": "my-tag",
    "resources": {
      "count": 1,
      "flexMetalServers": {
        "count": 1
      }
    }
  }
]

Get a tag by name

get

Authorizations

PRIVATE-TOKENstringRequired

Responses

200

List of tags

application/json

A Flex Metal tag

tagstringRequired

The tag name

Example: my-tag

403

Invalid credentials

404

Resource not found

500

Internal Server Error

application/json

get

/v3/flexMetal/tags/{tag}

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

[
  {
    "tag": "my-tag",
    "resources": {
      "count": 1,
      "flexMetalServers": {
        "count": 1
      }
    }
  }
]

Rename a FlexMetal tag

put

Authorizations

PRIVATE-TOKENstringRequired

Body

A Flex Metal tag

tagstringRequired

The tag name

Example: my-tag

Responses

200

The updated tag model

application/json

A Flex Metal tag

tagstringRequired

The tag name

Example: my-tag

403

Invalid credentials

404

Resource not found

409

New tag name already exists

422

Unprocessable content

500

Internal Server Error

application/json

put

/v3/flexMetal/tags/{tag}

PUT /v3/flexMetal/tags/{tag} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "tag": "my-tag"
}

[
  {
    "tag": "my-tag",
    "resources": {
      "count": 1,
      "flexMetalServers": {
        "count": 1
      }
    }
  }
]

Delete a FlexMetal tag

delete

Authorizations

PRIVATE-TOKENstringRequired

Responses

204

No Content

403

Invalid credentials

404

Resource not found

500

Internal Server Error

application/json

delete

/v3/flexMetal/tags/{tag}

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

No content

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.

created

delivered

failed

releasing

released

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 · integerOptional

Server delivery timestamp.

Example: 1728031748

releasedAtinteger · integerOptional

Server release timestamp.

contractIdstringOptional

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.

created

delivered

failed

releasing

released

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 · integerOptional

Server delivery timestamp.

Example: 1728031748

releasedAtinteger · integerOptional

Server release timestamp.

contractIdstringOptional

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"
  }
]

Quota and usage

Get your FlexMetal quota and current usage numbers

get

Authorizations

PRIVATE-TOKENstringRequired

Responses

200

List of quota & current usage numbers

application/json

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/flexMetal/quota/usage

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

[
  {
    "location": {
      "id": 18,
      "name": "text"
    },
    "quotaUsage": [
      {
        "instanceType": {
          "id": 128,
          "name": "bm7.std.8"
        },
        "quotaType": "onDemand",
        "contractId": "JD-NB2UU6VX732",
        "quota": 5,
        "usage": 3
      }
    ]
  }
]

Retrieve a list of FlexMetal server usages

get

Authorizations

PRIVATE-TOKENstringRequired

Query parameters

startDatestringOptional

Must be a valid date string. E.g. YYYY-MM-DD.

endDatestringOptional

Must be a valid date string. E.g. YYYY-MM-DD.

Responses

200

application/json

startedAtstring · date-timeRequired

Usage tracking starts.

endedAtstring · date-timeRequired

Usage tracking ends.

totalHoursinteger · integerRequired

Total hours of usage.

totalMinutesinteger · integerRequired

Total minutes of usage.

bandwidthIninteger · integerRequired

Total bandwidth out.

totalEgressBytesinteger · integerRequired

Total egress bytes.

403

Forbidden

405

Method Not Allowed

422

Unprocessable Content

500

Internal Server Error

application/json

get

/v3/flexMetal/usage

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

[
  {
    "server": {
      "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"
    },
    "startedAt": "2026-06-07T17:29:10.159Z",
    "endedAt": "2026-06-07T17:29:10.159Z",
    "totalHours": 1,
    "totalMinutes": 1,
    "bandwidthIn": 1,
    "totalEgressBytes": 1
  }
]

Capacity

Deprecated. The /v3/flexMetal/capacity/commit endpoint is deprecated and will be removed in a future release. Responses include a Deprecation: true header.

Deprecated

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
      }
    ]
  }
]

PreviousFlexVM

Last updated 3 days ago

Was this helpful?