Skip to main content
POST
/
v1
/
regions
/
{region}
/
infrastructure
/
servers
Enroll server
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    hostname: '<string>',
    bmcAddress: '<string>',
    serialNumber: '<string>',
    tags: {}
  })
};

fetch('https://api.example.com/v1/regions/{region}/infrastructure/servers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "success": true,
  "data": {
    "id": "<string>",
    "hostname": "<string>",
    "status": "available",
    "health": "healthy",
    "regionId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "serialNumber": "<string>",
    "bmcAddress": "<string>",
    "profileId": "<string>",
    "specs": {
      "cpu": "<string>",
      "memoryGB": 123,
      "storageGB": 123,
      "nics": 123
    },
    "tags": {},
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Path Parameters

region
string
required

Region identifier

Body

application/json
hostname
string
required
bmcAddress
string | null
serialNumber
string | null
tags
object

Response

201 - application/json

Server enrolled

success
enum<boolean>
Available options:
true
data
object

Bare-metal server inventory entry