Baremetal Server API reference (1.0.0)
Download OpenAPI specification:Download
This manual explains how to use the Smart Data Platform Baremetal Server API
The following API manages to generate, update, list and delete baremetal servers. To get management console information, power on, power off and reboot specified baremetal server, please refer Server Actions.
List Servers
This API lists your baremetal servers information.
path Parameters
tenant_id required | string <uuid> ID for the tenant. |
query Parameters
changes-since | string <date-time> A time/date stamp for when the server last changed status. |
marker | string <uuid> UUID of the server at which you want to set a marker. Find servers from the next UUID of the given one. |
limit | integer Integer value for the limit of values to return. |
name | string Name of the server as a string. |
image | string Name of the image in URL format. This parameter can be obtained by GET /images API. |
flavor | string Name of the flavor in URL format. This parameter can be obtained by GET /flavors API. |
status | string Value of the status of the server so that you can filter on. |
Responses
OK
Bad Request
Unauthorized
Not Found
Method Not Allowed
Payload Too Large
Internal Server Error
Response samples
- 200
- 400
- 401
- 404
- 405
- 413
- 500
{- "servers": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "links": [
- {
- "rel": "self"
}, - {
- "rel": "bookmark"
}
], - "name": "new-server-test"
}, - {
- "id": "508f6eca-7387-5004-bfeb-64cbbbba7f19",
- "links": [
- {
- "rel": "self"
}, - {
- "rel": "bookmark"
}
], - "name": "new-server-test2"
}
]
}
Create Server
This API creates additional baremetal servers.
path Parameters
tenant_id required | string |
Request Body schema: application/json
- Standard Plan RHEL, CentOS, Ubuntu(without LVM)
- Standard Plan RHEL, CentOS, Ubuntu(with LVM)
- Standard Plan Windows
- Standard Plan ESXi
- Custom Plan
server | object |
Responses
OK
Bad Request
Unauthorized
Not Found
Method Not Allowed
Payload Too Large
Internal Server Error
Service Unavailable
Request samples
- Payload
{- "server": {
- "name": "server-test-1",
- "networks": [
- {
- "uuid": "d32019d3-bc6e-4319-9c1d-6722fc136a22",
- "fixed_ip": "10.0.0.100"
}
], - "adminPass": "aabbccddeeff",
- "imageRef": "string",
- "flavorRef": "0fbc4972-f9e6-448d-9f70-cf0b183c571d",
- "availability_zone": "zone1-groupa",
- "metadata": {
- "foo": "bar"
}, - "key_name": "<name>",
- "user_data": "IyEvYmluL2Jhc2gKZWNobyAiS3VtYSBQb3N0IEluc3RhbGwgU2NyaXB0IiA+PiAvaG9tZS9iaWcvcG9zdC1pbnN0YWxsLXNjcmlwdA==",
- "personality": {
- "path": "<path>",
- "contents": "<contents>"
}, - "raid_arrays": [
- {
- "primary_storage": true,
- "partitions": [
- {
- "size": "40G",
- "partition_label": "root"
}, - {
- "size": "auto",
- "partition_label": "home"
}, - {
- "size": "4G",
- "partition_label": "swap"
}
]
}
], - "filesystems": [
- {
- "label": "root",
- "fs_type": "ext4"
}, - {
- "label": "home",
- "mount_point": "/home",
- "fs_type": "ext4"
}, - {
- "label": "swap",
- "mount_point": "sawap"
}
]
}
}
Response samples
- 200
- 400
- 401
- 404
- 405
- 413
- 500
- 503
{- "server": {
- "id": "string",
- "links": [
- {
- "rel": "self"
}, - {
- "rel": "bookmark"
}
], - "adminPass": "aabbccddeeff"
}
}
Show Server
This API shows your baremetal server information.
path Parameters
tenant_id required | string <uuid> ID for the tenant. |
server_id required | string <uuid> ID for the server. |
Responses
OK
Bad Request
Unauthorized
Not Found
Method Not Allowed
Internal Server Error
Response samples
- 200
- 400
- 401
- 404
- 405
- 500
{- "server": {
- "OS-EXT-STS:power_state": "RUNNING",
- "OS-EXT-STS:task_state": "None",
- "OS-EXT-STS:vm_state": "ACTIVE",
- "OS-EXT-AZ:availability_zone": "zone1-groupa",
- "created": "2024-04-19T07:02:33Z",
- "flavor": {
- "id": "string",
- "links": [
- {
- "rel": "bookmark"
}
]
}, - "id": "string",
- "image": {
- "id": "string",
- "links": [
- {
- "rel": "bookmark"
}
]
}, - "links": [
- {
- "rel": "self"
}, - {
- "rel": "bookmark"
}
], - "metadata": {
- "AnyKey": "AnyValue"
}, - "name": "new-server-test",
- "progress": 0,
- "status": "ACTIVE",
- "tenant_id": "aaa8749130bc3d2886d6b9bb3fcb1715",
- "updated": "2024-04-19T07:02:33Z",
- "user_id": "fake",
- "managed_by_service": "dedicated-hypervisor",
- "managed_service_resource_id": "8d366088-95d7-4601-ae14-d0f7b37d1896",
- "raid_arrays": [
- {
- "primary_storage": true,
- "raid_card_hardware_id": "string",
- "disk_hardware_ids": [
- "string"
], - "raid_level": 0,
- "partitions": [
- {
- "lvm": true,
- "size": "string",
- "partition_label": "string"
}
], - "example": null
}
], - "lvm_volume_groups": [
- {
- "vg_label": "VG_root",
- "physical_volume_partition_labels": [
- "primary-part1",
- "secondary-part1"
], - "logical_volumes": [
- {
- "lv_label": "LV_root"
}, - {
- "size": "2G",
- "lv_label": "LV_swap"
}
]
}
], - "filesystems": [
- {
- "label": "LV_root",
- "mount_point": "/",
- "fs_type": "xfs"
}, - {
- "label": "var",
- "mount_point": "/var",
- "fs_type": "xfs"
}, - {
- "label": "LV_swap",
- "mount_point": "swap"
}
], - "nic_physical_ports": [
- {
- "id": "39285bf9-12fb-4064-b98b-a552efc51cfc",
- "mac_addr": "0a:31:c1:d5:6d:9c",
- "network_physical_port_id": "38268d94-584a-4f14-96ff-732a68aa7301",
- "plane": "data",
- "attached_ports": [
- {
- "port_id": "61b7da1e-9571-4d63-b779-e003a56b8105",
- "network_id": "9aa93722-1ec4-4912-b813-b975c21460a5",
- "fixed_ips": [
- {
- "subnet_id": "0419bbde-2b82-4107-9d8a-6bba76e364af",
- "ip_address": "192.168.10.2"
}
]
}
], - "hardware_id": "063468e8-61ab-4afd-be38-c937254aeb9a"
}
], - "chassis-status": {
- "chassis-power": true,
- "power-supply": true,
- "cpu": true,
- "memory": true,
- "fan": true,
- "disk": 0,
- "nic": true,
- "system-board": true,
- "etc": true
}, - "media_attachments": [
- {
- "image": {
- "id": "3339fd5f-ec06-4ef8-9337-c1c70218a748",
- "links": [
- {
- "rel": "bookmark"
}
]
}
}
]
}
}
Update baremetal server information
This API updates the editable attributes of the specified baremetal server.
path Parameters
tenant_id required | string <uuid> ID for the tenant. |
server_id required | string <uuid> ID for the server. |
Request Body schema: application/json
server | object |
Responses
OK
Bad Request
Unauthorized
Forbidden
Not Found
Method Not Allowed
Internal Server Error
Service Unavailable
Request samples
- Payload
{- "server": {
- "name": "server-test-1"
}
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 405
- 500
- 503
{- "server": {
- "OS-EXT-STS:power_state": "RUNNING",
- "OS-EXT-STS:task_state": "None",
- "OS-EXT-STS:vm_state": "ACTIVE",
- "OS-EXT-AZ:availability_zone": "zone1-groupa",
- "created": "2024-04-19T07:02:33Z",
- "flavor": {
- "id": "string",
- "links": [
- {
- "rel": "bookmark"
}
]
}, - "id": "string",
- "image": {
- "id": "string",
- "links": [
- {
- "rel": "bookmark"
}
]
}, - "links": [
- {
- "rel": "self"
}, - {
- "rel": "bookmark"
}
], - "metadata": {
- "AnyKey": "AnyValue"
}, - "name": "new-server-test",
- "progress": 0,
- "status": "ACTIVE",
- "tenant_id": "aaa8749130bc3d2886d6b9bb3fcb1715",
- "updated": "2024-04-19T07:02:33Z",
- "user_id": "fake",
- "managed_by_service": "dedicated-hypervisor",
- "managed_service_resource_id": "8d366088-95d7-4601-ae14-d0f7b37d1896",
- "raid_arrays": [
- {
- "primary_storage": true,
- "raid_card_hardware_id": "string",
- "disk_hardware_ids": [
- "string"
], - "raid_level": 0,
- "partitions": [
- {
- "lvm": true,
- "size": "string",
- "partition_label": "string"
}
], - "example": null
}
], - "lvm_volume_groups": [
- {
- "vg_label": "VG_root",
- "physical_volume_partition_labels": [
- "primary-part1",
- "secondary-part1"
], - "logical_volumes": [
- {
- "lv_label": "LV_root"
}, - {
- "size": "2G",
- "lv_label": "LV_swap"
}
]
}
], - "filesystems": [
- {
- "label": "LV_root",
- "mount_point": "/",
- "fs_type": "xfs"
}, - {
- "label": "var",
- "mount_point": "/var",
- "fs_type": "xfs"
}, - {
- "label": "LV_swap",
- "mount_point": "swap"
}
], - "nic_physical_ports": [
- {
- "id": "39285bf9-12fb-4064-b98b-a552efc51cfc",
- "mac_addr": "0a:31:c1:d5:6d:9c",
- "network_physical_port_id": "38268d94-584a-4f14-96ff-732a68aa7301",
- "plane": "data",
- "attached_ports": [
- {
- "port_id": "61b7da1e-9571-4d63-b779-e003a56b8105",
- "network_id": "9aa93722-1ec4-4912-b813-b975c21460a5",
- "fixed_ips": [
- {
- "subnet_id": "0419bbde-2b82-4107-9d8a-6bba76e364af",
- "ip_address": "192.168.10.2"
}
]
}
], - "hardware_id": "063468e8-61ab-4afd-be38-c937254aeb9a"
}
], - "chassis-status": {
- "chassis-power": true,
- "power-supply": true,
- "cpu": true,
- "memory": true,
- "fan": true,
- "disk": 0,
- "nic": true,
- "system-board": true,
- "etc": true
}, - "media_attachments": [
- {
- "image": {
- "id": "3339fd5f-ec06-4ef8-9337-c1c70218a748",
- "links": [
- {
- "rel": "bookmark"
}
]
}
}
]
}
}
Delete Server
This API deletes a specified baremetal server.
path Parameters
tenant_id required | string ID for the tenant. |
server_id required | string ID for the server. |
Responses
No Content
Bad Request
Unauthorized
Not Found
Method Not Allowed
Conflict
Internal Server Error
Service Unavailable
Response samples
- 400
- 401
- 404
- 405
- 409
- 500
- 503
{- "badRequest": {
- "code": 400,
- "message": "Request Parameter Error:\\n"
}
}
List Servers Details
This API lists your baremetal servers information.
path Parameters
tenant_id required | string <uuid> ID for the tenant. |
query Parameters
changes-since | string <date-time> A time/date stamp for when the server last changed status. |
marker | string <uuid> UUID of the server at which you want to set a marker. Find servers from the next UUID of the given one. |
limit | integer Integer value for the limit of values to return. |
name | string Name of the server as a string. |
image | string Name of the image in URL format. This parameter can be obtained by GET /images API. |
flavor | string Name of the flavor in URL format. This parameter can be obtained by GET /flavors API. |
status | string Value of the status of the server so that you can filter on. |
Responses
OK
Bad Request
Unauthorized
Forbidden
Not Found
Method Not Allowed
Internal Server Error
Response samples
- 200
- 400
- 401
- 403
- 404
- 405
- 500
{- "servers": [
- {
- "OS-EXT-STS:power_state": "RUNNING",
- "OS-EXT-STS:task_state": "None",
- "OS-EXT-STS:vm_state": "ACTIVE",
- "OS-EXT-AZ:availability_zone": "zone1-groupa",
- "created": "2019-08-24T14:15:22.000Z",
- "flavor": {
- "id": "05184ba3-00ba-4fbc-b7a2-03b62b884931",
- "links": [
- {
- "rel": "self"
}
]
}, - "id": "05184ba3-00ba-4fbc-b7a2-03b62b884931",
- "image": {
- "id": "70a599e0-31e7-49b7-b260-868f441e862b",
- "links": [
- {
- "rel": "bookmark"
}
]
}, - "links": [
- {
- "rel": "self"
}, - {
- "rel": "bookmark"
}
], - "metadata": {
- "AnyKey": "AnyValue"
}, - "name": "new-server-test",
- "progress": 0,
- "status": "ACTIVE",
- "tenant_id": "aaa8749130bc3d2886d6b9bb3fcb1715",
- "updated": "2012-09-07T16:56:37.000Z",
- "user_id": "270dd02f-2abf-48bd-813a-f8a4470da7f7",
- "raid_arrays": [
- {
- "primary_storage": true,
- "raid_card_hardware_id": "fakeraid_card_uuid",
- "disk_hardware_ids": [
- "disk0_uuid",
- "disk1_uuid",
- "disk2_uuid",
- "disk3_uuid"
], - "partitions": [
- {
- "lvm": true,
- "partition_label": "partition_label"
}, - {
- "lvm": false,
- "size": "100G",
- "partition_label": "var"
}
]
}, - {
- "primary_storage": false,
- "raid_card_hardware_id": "fakeraid_card_uuid",
- "disk_hardware_ids": [
- "disk4_uuid",
- "disk5_uuid",
- "disk6_uuid",
- "disk7_uuid"
], - "raid_level": 10,
- "partitions": [
- {
- "lvm": true,
- "partition_label": "secondary-part1"
}
]
}
], - "lvm_volume_groups": [
- {
- "vg_label": "VG_root",
- "physical_volume_partition_labels": [
- "primary-part1",
- "secondary-part1"
], - "logical_volumes": [
- {
- "lv_label": "LV_root"
}, - {
- "size": "2G",
- "lv_label": "LV_swap"
}
]
}
], - "filesystems": [
- {
- "label": "LV_root",
- "mount_point": "/",
- "fs_type": "xfs"
}, - {
- "label": "var",
- "mount_point": "/var",
- "fs_type": "xfs"
}, - {
- "label": "LV_swap",
- "mount_point": "swap"
}
], - "nic_physical_ports": [
- {
- "id": "39285bf9-12fb-4064-b98b-a552efc51cfc",
- "mac_addr": "0a:31:c1:d5:6d:9c",
- "network_physical_port_id": "38268d94-584a-4f14-96ff-732a68aa7301",
- "plane": "data",
- "attached_ports": [
- {
- "port_id": "61b7da1e-9571-4d63-b779-e003a56b8105",
- "network_id": "9aa93722-1ec4-4912-b813-b975c21460a5",
- "fixed_ips": [
- {
- "subnet_id": "0419bbde-2b82-4107-9d8a-6bba76e364af",
- "ip_address": "192.168.10.2"
}
]
}
], - "hardware_id": "063468e8-61ab-4afd-be38-c937254aeb9a"
}
], - "chassis-status": {
- "chassis-power": true,
- "power-supply": true,
- "cpu": true,
- "memory": true,
- "fan": true,
- "disk": 0,
- "nic": true,
- "system-board": true,
- "etc": true
}, - "media_attachments": [
- {
- "image": {
- "id": "3339fd5f-ec06-4ef8-9337-c1c70218a748",
- "links": [
- {
- "rel": "bookmark"
}
]
}
}
]
}
]
}
The following API manages to get management console information, power on, power off and reboot specified server. These API request will be accepted only when is the task_state is None. To add, update or delete server, please refer Servers.
Server Actions
The following API manages to get management console information, power on, power off and reboot specified server. These API request will be accepted only when the task_state is None. To create, update or delete server, please refer Servers.
You can perform the following functions with request body.
Action | Description |
---|---|
Get Management Console | Gets information to access the remote console of Baremetal Server. This request will be accepted only when the task_state is None. This API response console parameters are used at Remote Console Access. To access your Baremetal Server, you have to create VPN user and connect to VPN. |
Start Server | Power on the Baremetal Server associated with server_id. This request will be accepted only when the task_state is None. |
Stop Server | Stop the Baremetal Server associated with server_id. This request will be accepted only when the task_state is None. |
Reboot Server | Reboot the Baremetal Server associated with server_id. This request will be accepted only when the task_state is None. |
Change Boot Mode of Server | Change boot mode of the Baremetal Server associated with server_id. This request will be accepted only when the task_state is None. |
Media Attach to Server | Attach media to the Baremetal Server associated with server_id. This request will be accepted only when the task_state is None. |
Media Detach from Server | Detach media from the Baremetal Server associated with server_id. This request will be accepted only when the task_state is None. |
Reset BMC | Reset the Baseboard Management Controller. This request will be accepted only when the task_state is None. |
path Parameters
tenant_id required | string Example: aaa8749130bc3d2886d6b9bb3fcb1715 |
server_id required | string <uuid> |
Request Body schema: application/json
- Get Management Console
- Start Server
- Stop Server
- Reboot Server
- Change Boot Mode of Server
- Media Attach to Server
- Media Detach from Server
- Reset BMC
os-getManagementConsole required | The console acquisition request object. |
Responses
OK
Accepted
Bad Request
Unauthorized
Forbidden
Not Found
Method Not Allowed
Conflict
Payload Too Large
Internal Server Error
Request samples
- Payload
{- "os-getManagementConsole": null
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 405
- 409
- 413
- 500
{- "console": {
- "type": "IPMI",
- "user_id": "270dd02f-2abf-48bd-813a-f8a4470da7f7",
- "password": "fake_password"
}
}
The following API manages to get availability_zone. A availability_zone indicate location of VMs.
Show AvailabilityZone
This API manages to get availability_zone. A availability_zone indicate location of VMs.
path Parameters
tenant_id required | string <uuid> ID for the tenant. |
Responses
OK
Bad Request
Unauthorized
Forbidden
Method Not Allowed
Internal Server Error
Response samples
- 200
- 400
- 401
- 403
- 405
- 500
{- "availabilityZoneInfo": [
- {
- "zoneName": "zone1-groupa",
- "hosts": null,
- "zoneState": {
- "available": true
}
}
]
}
The following API manages to get available flavors or specified flavor. A flavor is a hardware configuration for a server. Each flavor is a unique combination of disk space and memory capacity. The flavorRef (UUID or URL of flavor) specified in the request body in Create Server request. Additionally, uuid of the flavor is included in the parameter of the Server.
Show Flavor Detail
Gets details for a FlavorDetail associated with flavor_id. A flavor is a hardware configuration for a server. Each flavor is a unique combination of disk space and memory capacity.
path Parameters
tenant_id required | string <uuid> ID for the tenant. |
flavor_id required | string <uuid> ID for the flavor. This is used at Create Server as flavorRef parameter. |
Responses
OK
Bad Request
Unauthorized
Not Found
Method Not Allowed
Bad Media Type
Internal Server Error
Response samples
- 200
- 400
- 401
- 404
- 405
- 415
- 500
{- "flavor": {
- "id": "b97bcc03-f89d-49c3-9376-a50e661e09e7",
- "disk": 550,
- "links": [
], - "name": "General Purpose 2",
- "ram": 262144,
- "vcpus": 24
}
}
List Flavors
Lists all Flavor. That hash only id, links and name. If you want to get detail flavor information, call List Flavors Detail API. A flavor is a hardware configuration for a server. Each flavor is a unique combination of disk space and memory capacity.
path Parameters
tenant_id required | string <uuid> ID for the tenant. |
Responses
OK
Bad Request
Unauthorized
Not Found
Method Not Allowed
Bad Media Type
Internal Server Error
Response samples
- 200
- 400
- 401
- 404
- 405
- 415
- 500
{- "flavors": [
- {
- "id": "05184ba3-00ba-4fbc-b7a2-03b62b884931",
- "links": [
], - "name": "General Purpose 1"
}, - {
- "id": "70a599e031e749b7b260868f441e862b",
- "links": [
], - "name": "General Purpose 2"
}
]
}
List Flavors Detail
Lists all FlavorDetail. A flavor is a hardware configuration for a server. Each flavor is a unique combination of disk space and memory capacity.
path Parameters
tenant_id required | string <uuid> ID for the tenant. |
Responses
OK
Bad Request
Unauthorized
Forbidden
Not Found
Method Not Allowed
Bad Media Type
Internal Server Error
Response samples
- 200
- 400
- 401
- 403
- 404
- 405
- 415
- 500
{- "flavors": [
- {
- "id": "b97bcc03-f89d-49c3-9376-a50e661e09e7",
- "disk": 550,
- "links": [
], - "name": "General Purpose 2",
- "ram": 262144,
- "vcpus": 24
}, - {
- "id": "70a599e0-31e7-49b7-b260-868f441e862b",
- "disk": 550,
- "links": [
], - "name": "General Purpose 2",
- "ram": 262144,
- "vcpus": 24
}
]
}
The following API manages to get available chassis or specified flavor, and their hardwares. A chassis represents base object of baremetal server. Each chassis is assigned an unique id and has dedicated disk spaces, memory capacities and cpu resources. If you contract Baremetal Server Custom Plan, you can get your ordered chassis list and deploy baremetal server instance by specifying an id of your selected chassis. See Create Server.
List Chassis
Lists all chassis, that has has id, availability_zone, flavor_name, hardware_summary, server_id and status.
If you want to get detail chassis information, call See List Chassis Detail API.
A chassis represents base object of baremetal server.
Each chassis is assigned an unique id and has dedicated disk spaces, memory capacities and cpu resources.
You can create baremetal server upon this object.
See Create Server.
path Parameters
tenant_id required | string <uuid> ID for the tenant. |
Responses
OK
Unauthorized
Method Not Allowed
Internal Server Error
Response samples
- 200
- 401
- 405
- 500
{- "chassis": [
- {
- "id": "string",
- "availability_zone": "zone1-groupa",
- "flavor_name": "Custom Plan v3",
- "hardware_summary": {
- "cpu": "8core*2",
- "ram": "64GB",
- "disk": "480GB*2, 960GB*4"
}, - "status": "Available",
- "server_id": "string",
- "server_name": "server_01",
- "contract_year": 2,
- "start_time": "2024-04-19T07:02:33Z"
}
]
}
List Chassis Detail
Lists all ChassisDetail.
A chassis represents base object of baremetal server.
Each chassis is assigned an unique id and has dedicated disk spaces, memory capacities and cpu resources.
You can create baremetal server upon this object. See Create Server.
You can get only summary of hardwares in List Chassis, but you can get details of hardwares in this API.
path Parameters
tenant_id required | string <uuid> ID for the tenant. |
Responses
OK
Unauthorized
Method Not Allowed
Internal Server Error
Response samples
- 200
- 401
- 405
- 500
{- "chassis": [
- {
- "id": "string",
- "availability_zone": "zone1-groupa",
- "flavor_name": "Custom Plan v3",
- "hardware_summary": {
- "cpu": "8core*2",
- "ram": "64GB",
- "disk": "480GB*2, 960GB*4"
}, - "status": "Available",
- "server_id": "string",
- "server_name": "server_01",
- "contract_year": 2,
- "start_time": "2024-04-19T07:02:33Z",
- "cpus": [
- {
- "description": "Intel Xeion Silver 4208",
- "specification": {
- "vendor": "INTEL",
- "frequency": "2.10Ghz",
- "cache": "11MB",
- "cores": 8
}
}, - {
- "description": "Intel Xeion Silver 4208",
- "specification": {
- "vendor": "INTEL",
- "frequency": "2.10Ghz",
- "cache": "11MB",
- "cores": 8
}
}
], - "disks": [
- {
- "description": "SATA 6Gbps 480GB NAND based SSD",
- "specification": {
- "size": "480GB",
- "rpm": 0,
- "interface": "SATA",
- "interface_speed": "6Gbps"
}
}, - {
- "description": "SATA 6Gbps 480GB NAND based SSD",
- "specification": {
- "size": "480GB",
- "rpm": 0,
- "interface": "SATA",
- "interface_speed": "6Gbps"
}
}, - {
- "description": "HPE 960GB SATA 6G Read Intensive SFF SC Multi Vendor SSD P18424-B21",
- "specification": {
- "size": "960GB",
- "rpm": 0,
- "interface": "SATA",
- "interface_speed": "6Gbps"
}
}, - {
- "description": "HPE 960GB SATA 6G Read Intensive SFF SC Multi Vendor SSD P18424-B21",
- "specification": {
- "size": "960GB",
- "rpm": 0,
- "interface": "SATA",
- "interface_speed": "6Gbps"
}
}
], - "rams": [
- {
- "description": "DDR4 32GB 2666Mhz ECC RAM",
- "specification": {
- "type": "DDR4",
- "speed": "2666MHz",
- "size": "32768MB"
}
}, - {
- "description": "DDR4 32GB 2666Mhz ECC RAM",
- "specification": {
- "type": "DDR4",
- "speed": "2666MHz",
- "size": "32768MB"
}
}
]
}
]
}
Show Chassis Detail
Gets details for a chassis associated with chassis_id. A chassis represents base object of baremetal server. Each chassis is assigned an unique id and has dedicated disk spaces, memory capacities and cpu resources. You can create baremetal server upon this object. You can get only summary of hardwares in List Chassis, but you can get details of hardwares in this API.
path Parameters
tenant_id required | string <uuid> ID for the tenant. |
chassis_id required | string <uuid> ID for the chassis. This is used at Create Server. |
Responses
OK
Unauthorized
Not Found
Method Not Allowed
Internal Server Error
Response samples
- 200
- 401
- 404
- 405
- 500
{- "chassis": {
- "id": "string",
- "availability_zone": "zone1-groupa",
- "flavor_name": "Custom Plan v3",
- "hardware_summary": {
- "cpu": "8core*2",
- "ram": "64GB",
- "disk": "480GB*2, 960GB*4"
}, - "status": "Available",
- "server_id": "string",
- "server_name": "server_01",
- "contract_year": 2,
- "start_time": "2024-04-19T07:02:33Z",
- "cpus": [
- {
- "description": "Intel Xeion Silver 4208",
- "specification": {
- "vendor": "INTEL",
- "frequency": "2.10Ghz",
- "cache": "11MB",
- "cores": 8
}
}, - {
- "description": "Intel Xeion Silver 4208",
- "specification": {
- "vendor": "INTEL",
- "frequency": "2.10Ghz",
- "cache": "11MB",
- "cores": 8
}
}
], - "disks": [
- {
- "description": "SATA 6Gbps 480GB NAND based SSD",
- "specification": {
- "size": "480GB",
- "rpm": 0,
- "interface": "SATA",
- "interface_speed": "6Gbps"
}
}, - {
- "description": "SATA 6Gbps 480GB NAND based SSD",
- "specification": {
- "size": "480GB",
- "rpm": 0,
- "interface": "SATA",
- "interface_speed": "6Gbps"
}
}, - {
- "description": "HPE 960GB SATA 6G Read Intensive SFF SC Multi Vendor SSD P18424-B21",
- "specification": {
- "size": "960GB",
- "rpm": 0,
- "interface": "SATA",
- "interface_speed": "6Gbps"
}
}, - {
- "description": "HPE 960GB SATA 6G Read Intensive SFF SC Multi Vendor SSD P18424-B21",
- "specification": {
- "size": "960GB",
- "rpm": 0,
- "interface": "SATA",
- "interface_speed": "6Gbps"
}
}
], - "rams": [
- {
- "description": "DDR4 32GB 2666Mhz ECC RAM",
- "specification": {
- "type": "DDR4",
- "speed": "2666MHz",
- "size": "32768MB"
}
}, - {
- "description": "DDR4 32GB 2666Mhz ECC RAM",
- "specification": {
- "type": "DDR4",
- "speed": "2666MHz",
- "size": "32768MB"
}
}
]
}
}
The following API manages to generate, import, and delete SSH keys. After generating a KeyPair, please specify the key_name parameter in the request body in Create Server request to associate the new server with SSH keys.
Create or Import KeyPair
Generate or import SSH keys. After generating a KeyPair, please specify the key_name parameter in the request body in Create Server request to associate the new server with SSH keys.
path Parameters
tenant_id required | string <uuid> ID for the tenant. |
Request Body schema: application/json
- Generate KeyPair (with private key)
- Import KeyPair (without private key)
keypair | object |
Responses
Bad Request
Unauthorized
Method Not Allowed
Conflict
Payload Too Large
Bad Media Type
Internal Server Error
Request samples
- Payload
{- "keypair": {
- "name": "generated-key",
- "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAQQC9A6d3dY2K/QeCBsO+DFE1zfCn2skqZE+umJaUNy99BG25W7EnvHmwzJIzwobsc834lUCWhxQ01EUYRZUp+GLH"
}
}
Response samples
- 200
- 400
- 401
- 405
- 409
- 413
- 415
- 500
{- "keypair": {
- "name": "generated-key",
- "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAQQC9A6d3dY2K/QeCBsO+DFE1zfCn2skqZE+umJaUNy99BG25W7EnvHmwzJIzwobsc834lUCWhxQ01EUYRZUp+GLH",
- "private_key": "<private_key>",
- "fingerprint": "ce:66:48:df:f8:23:49:9c:d6:00:e3:74:d1:0c:0a:26",
- "user_id": "270dd02f-2abf-48bd-813a-f8a4470da7f7"
}
}
List KeyPairs
Lists name, public_key and finger_print for all KeyPairs.
path Parameters
tenant_id required | string <uuid> ID for the tenant. |
Responses
OK
Bad Request
Unauthorized
Method Not Allowed
Payload Too Large
Internal Server Error
Response samples
- 200
- 400
- 401
- 405
- 415
- 500
{- "keypairs": [
- {
- "name": "public-key1",
- "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAQQC9A6d3dY2K/QeCBsO+DFE1zfCn2skqZE+umJaUNy99BG25W7EnvHmwzJIzwobsc834lUCWhxQ01EUYRZUp+GLH",
- "fingerprint": "ce:66:48:df:f8:23:49:9c:d6:00:e3:74:d1:0c:0a:26"
}, - {
- "name": "public-key2",
- "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAQQCtzdf5vKNNSoeMfTUUj65eJLMjXfIbtc2GQn6+EEISHX6vjBzsTMdToQJEhgg+5rYlb5tc2mvPYNbPDIJV8OyV",
- "fingerprint": "2c:42:86:f4:a0:2f:b9:96:a6:e5:d9:31:c8:a3:73:1d"
}
]
}
Delete KeyPair
Delete KeyPair associated with keypair_name.
path Parameters
tenant_id required | string <uuid> ID for the tenant. |
keypair_name required | string The name associated with a KeyPair. |
Responses
No Content
Bad Request
Unauthorized
Not Found
Method Not Allowed
Payload Too Large
Internal Server Error
Response samples
- 400
- 401
- 404
- 405
- 415
- 500
{- "badRequest": {
- "code": 400,
- "message": "Request Parameter Error:\\n"
}
}
Show KeyPair
Show a KeyPair associated with keypair_name.
path Parameters
tenant_id required | string <uuid> ID for the tenant. |
keypair_name required | string The name associated with a KeyPair. |
Responses
OK
Bad Request
Unauthorized
Not Found
Method Not Allowed
Payload Too Large
Internal Server Error
Response samples
- 200
- 400
- 401
- 404
- 405
- 415
- 500
{- "keypair": {
- "name": "public-key1",
- "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAQQC9A6d3dY2K/QeCBsO+DFE1zfCn2skqZE+umJaUNy99BG25W7EnvHmwzJIzwobsc834lUCWhxQ01EUYRZUp+GLH",
- "fingerprint": "ce:66:48:df:f8:23:49:9c:d6:00:e3:74:d1:0c:0a:26"
}
}
GET Limits
This API lists the current limits for the account.
path Parameters
tenant_id required | string Example: b322a85578de48beba0f92acce57869b ID for the tenant. |
Responses
OK
Unauthorized
Method Not Allowed
Internal Server Error
Response samples
- 200
- 401
- 405
- 500
{- "limits": {
- "absolute": {
- "maxPersonality": 10,
- "maxPersonalitySize": 10240,
- "maxServerMeta": 128,
- "maxTotalInstances": 128,
- "maxTotalKeypairs": 100,
- "totalInstancesUsed": 0
}, - "rate": [ ]
}
}
The following API manages metadata for a specified server. To add a Metadata to a server, please specify the key-value elements in the request body in Create Server request.
List Server Metadata Items
This API lists metadata for a specified server. This API is unavailable for Custom Plan.
path Parameters
tenant_id required | string <uuid> ID for the tenant. |
server_id required | string <uuid> ID for the server. |
Responses
OK
Bad Request
Unauthorized
Forbidden
Not Found
Method Not Allowed
Internal Server Error
Not Implemented
Response samples
- 200
- 400
- 401
- 403
- 404
- 405
- 500
- 501
{- "metadata": {
- "AnyKey": "AnyValue"
}
}
Merge Server Metadata Items
This API creates or merges metadata for a specified server.
The API replaces items which match the specified keys in the request.
The API does not remove items, unlike Replace Server Metadata Items.
This API is unavailable for Custom Plan.
path Parameters
tenant_id required | string <uuid> ID for the tenant. |
server_id required | string <uuid> ID for the server. |
Request Body schema: application/json
metadata | object |
Responses
OK
Bad Request
Unauthorized
Forbidden
Not Found
Method Not Allowed
Payload Too Large
Bad Media Type
Internal Server Error
Not Implemented
Request samples
- Payload
{- "metadata": {
- "AnyKey": "AnyValue"
}
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 405
- 413
- 415
- 500
- 501
{- "metadata": {
- "AnyKey": "AnyValue"
}
}
Replace Server Metadata Items
This API creates or replaces metadata for a specified server.
All existing metadata items are removed and completely replaced by the metadata items in the request.
If you don't want to remove existing items, please use Merge Server Metadata Items.
This API is unavailable for Custom Plan.
path Parameters
tenant_id required | string <uuid> ID for the tenant. |
server_id required | string <uuid> ID for the server. |
Request Body schema: application/json
metadata | object |
Responses
OK
Bad Request
Unauthorized
Forbidden
Not Found
Method Not Allowed
Payload Too Large
Bad Media Type
Internal Server Error
Not Implemented
Request samples
- Payload
{- "metadata": {
- "AnyKey": "AnyValue"
}
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 405
- 413
- 415
- 500
- 501
{- "metadata": {
- "AnyKey": "AnyValue"
}
}
Show Server Metadata Item
This API shows metadata item (key and value) by specifying key for a specified server. This API is unavailable for Custom Plan.
path Parameters
tenant_id required | string <uuid> ID for the tenant. |
server_id required | string <uuid> ID for the server. |
key required | string <uuid> A string. Maximum length is 255 characters. |
Responses
OK
Bad Request
Unauthorized
Forbidden
Not Found
Method Not Allowed
Internal Server Error
Not Implemented
Response samples
- 200
- 400
- 401
- 403
- 404
- 405
- 500
- 501
{- "metadata": {
- "AnyKey": "AnyValue"
}
}
Update Server Metadata Item
This API sets additional metadata item (key and value) by specifying key for a specified server. This API is unavailable for Custom Plan.
path Parameters
tenant_id required | string <uuid> ID for the tenant. |
server_id required | string <uuid> ID for the server. |
key required | string <uuid> A string. Maximum length is 255 characters. |
Request Body schema: application/json
metadata | object |
Responses
OK
Bad Request
Unauthorized
Forbidden
Not Found
Method Not Allowed
Payload Too Large
Bad Media Type
Internal Server Error
Not Implemented
Request samples
- Payload
{- "metadata": {
- "AnyKey": "AnyValue"
}
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 405
- 413
- 415
- 500
- 501
{- "metadata": {
- "AnyKey": "AnyValue"
}
}
Delete Server Metadata Item
This API deletes metadata item (key and value) by specifying key for a specified server. This API is unavailable for Custom Plan.
path Parameters
tenant_id required | string <uuid> ID for the tenant. |
server_id required | string <uuid> ID for the server. |
key required | string <uuid> A string. Maximum length is 255 characters. |
Request Body schema: application/json
metadata | object |
Responses
No Content
Bad Request
Unauthorized
Forbidden
Not Found
Method Not Allowed
Bad Media Type
Internal Server Error
Not Implemented
Request samples
- Payload
{- "metadata": {
- "AnyKey": "AnyValue"
}
}
Response samples
- 400
- 401
- 403
- 404
- 405
- 415
- 500
- 501
{- "badRequest": {
- "code": 400,
- "message": "Request Parameter Error:\\n"
}
}
The following API manages to get network information (e.g. MAC address) for the specified server.
List Nic Physical Ports
This API lists all NicPhysicalPort information for the specified server.
path Parameters
tenant_id required | string <uuid> ID for the tenant. |
server_id required | string <uuid> ID for the server. |
Responses
OK
Bad Request
Unauthorized
Forbidden
Method Not Allowed
Internal Server Error
Response samples
- 200
- 400
- 401
- 403
- 405
- 500
{- "nic_physical_ports": [
- {
- "id": "39285bf9-12fb-4064-b98b-a552efc51cfc",
- "mac_addr": "0a:31:c1:d5:6d:9c",
- "network_physical_port_id": "38268d94-584a-4f14-96ff-732a68aa7301",
- "plane": "0a:31:c1:d5:6d:9c",
- "attached_ports": [
- {
- "port_id": "61b7da1e-9571-4d63-b779-e003a56b8105",
- "network_id": "9aa93722-1ec4-4912-b813-b975c21460a5",
- "fixed_ips": [
- {
- "subnet_id": "0419bbde-2b82-4107-9d8a-6bba76e364af",
- "ip_address": "192.168.10.2"
}
]
}
], - "hardware_id": "063468e8-61ab-4afd-be38-c937254aeb9a"
}
]
}
Show Nic Physical Port
This API shows the specified NicPhysicalPort information for specified server.
path Parameters
tenant_id required | string <uuid> ID for the tenant. |
server_id required | string <uuid> ID for the server. |
nic_physical_port_id required | string <uuid> ID for the network interface port. |
Responses
OK
Bad Request
Unauthorized
Forbidden
Not Found
Method Not Allowed
Internal Server Error
Response samples
- 200
- 400
- 401
- 403
- 404
- 405
- 500
{- "nic_physical_port": {
- "id": "39285bf9-12fb-4064-b98b-a552efc51cfc",
- "mac_addr": "0a:31:c1:d5:6d:9c",
- "network_physical_port_id": "38268d94-584a-4f14-96ff-732a68aa7301",
- "plane": "0a:31:c1:d5:6d:9c",
- "attached_ports": [
- {
- "port_id": "61b7da1e-9571-4d63-b779-e003a56b8105",
- "network_id": "9aa93722-1ec4-4912-b813-b975c21460a5",
- "fixed_ips": [
- {
- "subnet_id": "0419bbde-2b82-4107-9d8a-6bba76e364af",
- "ip_address": "192.168.10.2"
}
]
}
], - "hardware_id": "063468e8-61ab-4afd-be38-c937254aeb9a"
}
}
The following API manages to get network information (e.g. MAC address) for the specified server.
Show Stock
This API shows Baremetal Server stock information.
path Parameters
tenant_id required | string <uuid> ID for the tenant. |
query Parameters
flavor_id required | string <uuid> UUID of the flavor for search stock. |
availability_zone | string Name of the AvailabilityZone. If you specified this parameter, search stock from baremetal servers that matching AvailabilityZone and flavor_id. If you omit this parameter, stock search from all baremetal servers that matching flavor_id. |
Responses
OK
Bad Request
Unauthorized
Forbidden
Method Not Allowed
Internal Server Error
Response samples
- 200
- 400
- 401
- 403
- 405
- 500
{- "stock": {
- "flavor_id": "string",
- "availability_zone": "zone1-groupa",
- "stock": true
}
}
The following API manages to get and update uefi settings of specified Baremetal server. Please refer following link (Baremetal Server Service description) for available settings.
Show UEFI
This API shows the UEFI setting information for specified Baremetal server.
path Parameters
tenant_id required | string <uuid> ID for the tenant. |
server_id required | string <uuid> ID for the server. |
Responses
OK
Bad Request
Unauthorized
Forbidden
Method Not Allowed
Internal Server Error
Response samples
- 200
- 400
- 401
- 404
- 405
- 500
{- "uefi": {
- "flavor_name": "General Purpose v2",
- "flavor_id": "string",
- "status": "SUCCESS",
- "updated": "2012-09-07T16:56:37.000Z",
- "message": "",
- "setting": {
- "AnyUEFISettingKey": {
- "value": "Enabled",
- "default": "Enabled",
- "type": "enum",
- "selection": [
- "Enabled",
- "Disabled"
]
}
}
}
}
Update UEFI
This API deletes metadata item (key and value) by specifying key for a specified server. This API is unavailable for Custom Plan.
path Parameters
tenant_id required | string <uuid> ID for the tenant. |
server_id required | string <uuid> ID for the server. |
Request Body schema: application/json
uefi | object |
Responses
OK
Bad Request
Unauthorized
Not Found
Method Not Allowed
Conflict
Bad Media Type
Internal Server Error
Not Implemented
Request samples
- Payload
{- "uefi": {
- "setting": {
- "AnyUEFISettingKey": {
- "value": "Enabled",
- "default": "Enabled",
- "type": "enum",
- "selection": [
- "Enabled",
- "Disabled"
]
}
}
}
}
Response samples
- 400
- 401
- 404
- 405
- 409
- 415
- 500
- 501
{- "badRequest": {
- "code": 400,
- "message": "Request Parameter Error:\\n"
}
}
Show Version 2 information
Show Baremetal Server API version.
Responses
OK
Unauthorized
Method Not Allowed
Bad Media Type
Internal Server Error
Response samples
- 200
- 401
- 405
- 415
- 500
{- "version": {
- "status": "CURRENT",
- "id": "v2",
}
}
List Versions information
List Baremetal Server API versions. Now, supported version is only 2.
Responses
OK
Unauthorized
Method Not Allowed
Bad Media Type
Internal Server Error
Response samples
- 200
- 401
- 405
- 415
- 500
{- "versions": [
- {
- "status": "CURRENT",
- "id": "v2",
}
]
}