Ctrlk
Go to i3D.netGet support
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Server

CRUD for servers

Find a server by ID

get

Returns a single server with basic details

Required scopes
This endpoint requires the following scopes:
Authorizations
X-Api-KeystringRequired
Path parameters
serverIdinteger · intRequired

ID of the server to return

Responses
200

Successful operation

get/api/server/{serverId}
GET /api/server/{serverId} HTTP/1.1
X-Api-Key: YOUR_API_KEY
Accept: */*

{
  "server": {
    "serverId": 79186,
    "machineUuid": "4c4c4544-0059-5810-8033-c8c04f584432",
    "serial": "HYX3XD2",
    "name": "Server 12653",
    "hostname": "host.example.com",
    "locationId": 18,
    "locationName": "EU: Rotterdam",
    "instanceTypeId": 126,
    "instanceTypeName": "bm1-std-4",
    "clientId": 12345,
    "contractId": "JD-NB2UU6VX732",
    "state": "isolated",
    "subState": "brokenHardware",
    "vendor": "Dell Inc.",
    "chassis": "PowerEdge R230",
    "firmwareVersion": 1.23,
    "ipmiVersion": 2,
    "ipAddresses": [
      {
        "ipAddress": "1.2.3.4",
        "ipType": "normal|bmc",
        "ipVersion": "v4|v6"
      }
    ],
    "macAddresses": [
      {
        "macAddress": "10:98:36:A0:80:33",
        "macType": "normal|bmc"
      }
    ],
    "disks": [
      {
        "name": "sda|nvmep0n1",
        "interface": "sata|nvme",
        "type": "hdd|ssd|sas|nvme"
      }
    ],
    "isolationReason": {
      "operationUuid": "0194bc95-e1a4-73a0-81be-ae17c3a7e92b",
      "reason": "Server encountered error in PXE ...",
      "createdAt": "2018-03-20T09:12:28.000Z"
    }
  }
}

Update a server's main properties by ID

patch

Update a server's locationId and instsanceTypeId properties by server ID.

Required scopes
This endpoint requires the following scopes:
Authorizations
X-Api-KeystringRequired
Path parameters
serverIdinteger · intRequired

ID of the server to patch and return

Body
Responses
200

Successful operation

patch/api/server/{serverId}
PATCH /api/server/{serverId} HTTP/1.1
X-Api-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 65

{
  "items": [
    {
      "op": "replace",
      "path": "instanceTypeId",
      "value": null
    }
  ]
}
{
  "server": {
    "serverId": 79186,
    "machineUuid": "4c4c4544-0059-5810-8033-c8c04f584432",
    "serial": "HYX3XD2",
    "name": "Server 12653",
    "hostname": "host.example.com",
    "locationId": 18,
    "locationName": "EU: Rotterdam",
    "instanceTypeId": 126,
    "instanceTypeName": "bm1-std-4",
    "clientId": 12345,
    "contractId": "JD-NB2UU6VX732",
    "state": "isolated",
    "subState": "brokenHardware",
    "vendor": "Dell Inc.",
    "chassis": "PowerEdge R230",
    "firmwareVersion": 1.23,
    "ipmiVersion": 2,
    "ipAddresses": [
      {
        "ipAddress": "1.2.3.4",
        "ipType": "normal|bmc",
        "ipVersion": "v4|v6"
      }
    ],
    "macAddresses": [
      {
        "macAddress": "10:98:36:A0:80:33",
        "macType": "normal|bmc"
      }
    ],
    "disks": [
      {
        "name": "sda|nvmep0n1",
        "interface": "sata|nvme",
        "type": "hdd|ssd|sas|nvme"
      }
    ],
    "isolationReason": {
      "operationUuid": "0194bc95-e1a4-73a0-81be-ae17c3a7e92b",
      "reason": "Server encountered error in PXE ...",
      "createdAt": "2018-03-20T09:12:28.000Z"
    }
  }
}

Find servers by IDs

get
Required scopes
This endpoint requires the following scopes:
Authorizations
X-Api-KeystringRequired
Query parameters
serverIdsstringRequired

Comma-separated list of server IDs

Pattern: ^\d+(,\d+)*$
Responses
200

Successful operation

application/json
get/api/server
GET /api/server?serverIds=text HTTP/1.1
X-Api-Key: YOUR_API_KEY
Accept: */*

{
  "servers": [
    {
      "server": {
        "serverId": 79186,
        "machineUuid": "4c4c4544-0059-5810-8033-c8c04f584432",
        "serial": "HYX3XD2",
        "name": "Server 12653",
        "hostname": "host.example.com",
        "locationId": 18,
        "locationName": "EU: Rotterdam",
        "instanceTypeId": 126,
        "instanceTypeName": "bm1-std-4",
        "clientId": 12345,
        "contractId": "JD-NB2UU6VX732",
        "state": "isolated",
        "subState": "brokenHardware",
        "vendor": "Dell Inc.",
        "chassis": "PowerEdge R230",
        "firmwareVersion": 1.23,
        "ipmiVersion": 2,
        "ipAddresses": [
          {
            "ipAddress": "1.2.3.4",
            "ipType": "normal|bmc",
            "ipVersion": "v4|v6"
          }
        ],
        "macAddresses": [
          {
            "macAddress": "10:98:36:A0:80:33",
            "macType": "normal|bmc"
          }
        ],
        "disks": [
          {
            "name": "sda|nvmep0n1",
            "interface": "sata|nvme",
            "type": "hdd|ssd|sas|nvme"
          }
        ],
        "isolationReason": {
          "operationUuid": "0194bc95-e1a4-73a0-81be-ae17c3a7e92b",
          "reason": "Server encountered error in PXE ...",
          "createdAt": "2018-03-20T09:12:28.000Z"
        }
      }
    }
  ]
}

Find a server's lshw dump by ID

get

Returns a single server's lshw dump

Required scopes
This endpoint requires the following scopes:
Authorizations
X-Api-KeystringRequired
Path parameters
serverIdinteger · intRequired

ID of the server to return

Responses
200

Successful operation

application/json
get/api/server/{serverId}/lshw
GET /api/server/{serverId}/lshw HTTP/1.1
X-Api-Key: YOUR_API_KEY
Accept: */*

{
  "serverLshw": {
    "createdAt": 1,
    "lshw": "text"
  }
}

Find a server's memory details by ID

get

Returns a single server's memory details

Required scopes
This endpoint requires the following scopes:
Authorizations
X-Api-KeystringRequired
Path parameters
serverIdinteger · intRequired

ID of the server to return

Responses
200

Successful operation

application/json
get/api/server/{serverId}/memory
GET /api/server/{serverId}/memory HTTP/1.1
X-Api-Key: YOUR_API_KEY
Accept: */*

{
  "serverMemory": [
    {
      "size": 16384
    }
  ]
}

Find a server's disk details by ID

get

Returns a single server's disk details

Required scopes
This endpoint requires the following scopes:
Authorizations
X-Api-KeystringRequired
Path parameters
serverIdinteger · intRequired

ID of the server to return

Responses
200

Successful operation

application/json
get/api/server/{serverId}/disks
GET /api/server/{serverId}/disks HTTP/1.1
X-Api-Key: YOUR_API_KEY
Accept: */*

{
  "serverStorage": [
    {
      "size": 500000
    }
  ]
}

Find a server's network interface details by ID

get

Returns a single server's network interface details

Required scopes
This endpoint requires the following scopes:
Authorizations
X-Api-KeystringRequired
Path parameters
serverIdinteger · intRequired

ID of the server to return

Responses
200

Successful operation

application/json
get/api/server/{serverId}/interfaces
GET /api/server/{serverId}/interfaces HTTP/1.1
X-Api-Key: YOUR_API_KEY
Accept: */*

{
  "serverInterfaces": [
    {
      "vendor": "Mellanox"
    }
  ]
}

Checks if any server can be delivered to the client

get
Query parameters
instanceTypeIdinteger · intRequired

instance type id

locationIdinteger · intOptional

location id

clientIdinteger · intRequired

client id

contractIdstringOptional

contract id

Pattern: ^[A-Z0-9_\-.]{0,240}$
overflowbooleanOptional

If true, the allocation will be allowed to overflow the client's quota and use on-demand quota

Default: falseExample: false
Responses
200

Successful operation

application/json
resultbooleanOptionalExample: false
get/api/server/availability/verify
GET /api/server/availability/verify?instanceTypeId=1&clientId=1 HTTP/1.1
Accept: */*
200

Successful operation

{
  "result": false,
  "details": [
    {
      "name": "quota",
      "result": false,
      "message": "Client quota exceeded"
    }
  ]
}

Last updated

Was this helpful?