Documentation Powered by ReDoc

Baremetal Server API reference (1.0.0)

Download OpenAPI specification:Download

URL: https://sdpf.ntt.com/ License: © NTT DOCOMO BUSINESS, Inc. All Rights Reserved Terms of Service

This manual explains how to use the Smart Data Platform Baremetal Server API

Server

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

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

405

Method Not Allowed

413

Payload Too Large

500

Internal Server Error

get/{tenant_id}/servers
https://{api_endpoint}/v2/{tenant_id}/servers

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{}

Create Server

This API creates additional baremetal servers.

path Parameters
tenant_id
required
string
Request Body schema: application/json
One of
  • Standard Plan RHEL, CentOS, Ubuntu(without LVM)
  • Standard Plan RHEL, CentOS, Ubuntu(with LVM)
  • Standard Plan Windows
  • Standard Plan ESXi, Nutanix
server
object

Responses

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

405

Method Not Allowed

413

Payload Too Large

500

Internal Server Error

503

Service Unavailable

post/{tenant_id}/servers
https://{api_endpoint}/v2/{tenant_id}/servers

Request samples

Content type
application/json
Example
Standard Plan RHEL, CentOS, Ubuntu(without LVM)
Copy
 Expand all Collapse all
{
  • "server":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{}

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

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

405

Method Not Allowed

500

Internal Server Error

get/{tenant_id}/servers/{server_id}
https://{api_endpoint}/v2/{tenant_id}/servers/{server_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "server":
    {
    }
}

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

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

500

Internal Server Error

503

Service Unavailable

put/{tenant_id}/servers/{server_id}
https://{api_endpoint}/v2/{tenant_id}/servers/{server_id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "server":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "server":
    {
    }
}

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

204

No Content

400

Bad Request

401

Unauthorized

404

Not Found

405

Method Not Allowed

409

Conflict

500

Internal Server Error

503

Service Unavailable

delete/{tenant_id}/servers/{server_id}
https://{api_endpoint}/v2/{tenant_id}/servers/{server_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "badRequest":
    {
    }
}

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

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

500

Internal Server Error

get/{tenant_id}/servers/detail
https://{api_endpoint}/v2/{tenant_id}/servers/detail

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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 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.
Update BMC Password Update the password for the Baseboard Management Controller of the Baremetal Server associated with server_id.
This request will be accepted only when the task_state is None.
Get Remote Console Access This API provides the necessary information to access the Bare Metal Server's Baseboard Management Controller (BMC).
Specifically, it provides the destination URL and the access_code required for access.

By appending /remote-console-token-exchange to the issued URL, and sending a POST request with the access_code specified in the request body in JSON format ({ "access_code": "" }), the access_token will be returned in the Set-Cookie field of the response header.
You can then access the Bare Metal Server's BMC by accessing the issued URL with this access_token specified in the Cookie.

Please note that the validity period for the access_code is 1 minute, and the validity period for the access_token is 1 hour. Once the access_token is retrieved from an access_code, that access_code becomes invalid.
Disconnect Remote Console Access This API immediately revokes the access_token that was issued by the aforementioned Get Remote Console Access API, effectively expiring it prematurely.

Once the access_token is revoked, access to the BMC using that access_token will no longer be possible, and it will also become impossible to retrieve a access_token using the access_code.
path Parameters
tenant_id
required
string
Example: aaa8749130bc3d2886d6b9bb3fcb1715
server_id
required
string <uuid>
Request Body schema: application/json
One of
  • Get Management Console
  • Start Server
  • Stop Server
  • Reboot Server
  • Change Boot Mode of Server
  • Media Attach to Server
  • Media Detach from Server
  • Reset BMC
  • Update BMC Password
  • Get Remote Console Access
  • Disconnect Remote Console Access
os-getManagementConsole
required

The console acquisition request object.
This attribute is always null on Baremetal Server.

Responses

200

OK

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

409

Conflict

413

Payload Too Large

500

Internal Server Error

post/{tenant_id}/servers/{server_id}/action
https://{api_endpoint}/v2/{tenant_id}/servers/{server_id}/action

Request samples

Content type
application/json
Example
Get Management Console
Copy
 Expand all Collapse all
{
  • "os-getManagementConsole": null
}

Response samples

Content type
application/json
Example
Get Management Console
Copy
 Expand all Collapse all
{}

AvailabilityZone

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

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

405

Method Not Allowed

500

Internal Server Error

get/{tenant_id}/os-availability-zone
https://{api_endpoint}/v2/{tenant_id}/os-availability-zone

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "availabilityZoneInfo":
    [
    ]
}

Flavors

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

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

405

Method Not Allowed

415

Bad Media Type

500

Internal Server Error

get/flavors/{flavor_id}
https://{api_endpoint}/v2/{tenant_id}/flavors/{flavor_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{}

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

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

405

Method Not Allowed

415

Bad Media Type

500

Internal Server Error

get/flavors
https://{api_endpoint}/v2/{tenant_id}/flavors

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{}

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

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

415

Bad Media Type

500

Internal Server Error

get/flavors/detail
https://{api_endpoint}/v2/{tenant_id}/flavors/detail

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{}

KeyPairs

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
One of
  • Generate KeyPair (with private key)
  • Import KeyPair (without private key)
keypair
object

Responses

200
400

Bad Request

401

Unauthorized

405

Method Not Allowed

409

Conflict

413

Payload Too Large

415

Bad Media Type

500

Internal Server Error

post/os-keypairs
https://{api_endpoint}/v2/{tenant_id}/os-keypairs

Request samples

Content type
application/json
Example
Generate KeyPair (with private key)
Copy
 Expand all Collapse all
{
  • "keypair":
    {
    }
}

Response samples

Content type
application/json
Example
Generate KeyPair (with private key)
Copy
 Expand all Collapse all
{
  • "keypair":
    {
    }
}

List KeyPairs

Lists name, public_key and finger_print for all KeyPairs.

path Parameters
tenant_id
required
string <uuid>

ID for the tenant.

Responses

200

OK

400

Bad Request

401

Unauthorized

405

Method Not Allowed

415

Payload Too Large

500

Internal Server Error

get/os-keypairs
https://{api_endpoint}/v2/{tenant_id}/os-keypairs

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "keypairs":
    [
    ]
}

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

204

No Content

400

Bad Request

401

Unauthorized

404

Not Found

405

Method Not Allowed

415

Payload Too Large

500

Internal Server Error

delete/os-keypairs/{keypair_name}
https://{api_endpoint}/v2/{tenant_id}/os-keypairs/{keypair_name}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "badRequest":
    {
    }
}

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

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

405

Method Not Allowed

415

Payload Too Large

500

Internal Server Error

get/os-keypairs/{keypair_name}
https://{api_endpoint}/v2/{tenant_id}/os-keypairs/{keypair_name}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "keypair":
    {
    }
}

Limits

The following API manages to get numerical limits of server.

GET Limits

This API lists the current limits for the account.

path Parameters
tenant_id
required
string
Example: b322a85578de48beba0f92acce57869b

ID for the tenant.

Responses

200

OK

401

Unauthorized

405

Method Not Allowed

500

Internal Server Error

get/{tenant_id}/limits
https://{api_endpoint}/v2/{tenant_id}/limits

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "limits":
    {
    }
}

Metadata

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.

path Parameters
tenant_id
required
string <uuid>

ID for the tenant.

server_id
required
string <uuid>

ID for the server.

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

500

Internal Server Error

501

Not Implemented

get/{tenant_id}/servers/{server_id}/metadata/
https://{api_endpoint}/v2/{tenant_id}/servers/{server_id}/metadata/

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "metadata":
    {
    }
}

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.

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

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

413

Payload Too Large

415

Bad Media Type

500

Internal Server Error

501

Not Implemented

put/{tenant_id}/servers/{server_id}/metadata/
https://{api_endpoint}/v2/{tenant_id}/servers/{server_id}/metadata/

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "metadata":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "metadata":
    {
    }
}

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.

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

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

413

Payload Too Large

415

Bad Media Type

500

Internal Server Error

501

Not Implemented

post/{tenant_id}/servers/{server_id}/metadata/
https://{api_endpoint}/v2/{tenant_id}/servers/{server_id}/metadata/

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "metadata":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "metadata":
    {
    }
}

Show Server Metadata Item

This API shows metadata item (key and value) by specifying key for a specified server.

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

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

500

Internal Server Error

501

Not Implemented

get/{tenant_id}/servers/{server_id}/metadata/{key}
https://{api_endpoint}/v2/{tenant_id}/servers/{server_id}/metadata/{key}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "metadata":
    {
    }
}

Update Server Metadata Item

This API sets additional metadata item (key and value) by specifying key for a specified server.

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

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

413

Payload Too Large

415

Bad Media Type

500

Internal Server Error

501

Not Implemented

put/{tenant_id}/servers/{server_id}/metadata/{key}
https://{api_endpoint}/v2/{tenant_id}/servers/{server_id}/metadata/{key}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "metadata":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "metadata":
    {
    }
}

Delete Server Metadata Item

This API deletes metadata item (key and value) by specifying key for a specified server.

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

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

415

Bad Media Type

500

Internal Server Error

501

Not Implemented

delete/{tenant_id}/servers/{server_id}/metadata/{key}
https://{api_endpoint}/v2/{tenant_id}/servers/{server_id}/metadata/{key}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "metadata":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "badRequest":
    {
    }
}

NicPhysicalPorts

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

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

405

Method Not Allowed

500

Internal Server Error

get/{tenant_id}/servers/{server_id}/nic_physical_ports
https://{api_endpoint}/v2/{tenant_id}/servers/{server_id}/nic_physical_ports

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "nic_physical_ports":
    [
    ]
}

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

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

500

Internal Server Error

get/{tenant_id}/servers/{server_id}/nic_physical_ports/{nic_physical_port_id}
https://{api_endpoint}/v2/{tenant_id}/servers/{server_id}/nic_physical_ports/{nic_physical_port_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "nic_physical_port":
    {
    }
}

Stock

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

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

405

Method Not Allowed

500

Internal Server Error

get/{tenant_id}/stock
https://{api_endpoint}/v2/{tenant_id}/stock

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "stock":
    {
    }
}

UEFI

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

200

OK

400

Bad Request

401

Unauthorized

404

Forbidden

405

Method Not Allowed

500

Internal Server Error

get/{tenant_id}/servers/{server_id}/uefi
https://{api_endpoint}/v2/{tenant_id}/servers/{server_id}/uefi

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "uefi":
    {
    }
}

Update UEFI

This API deletes metadata item (key and value) by specifying key for a specified 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
uefi
object

Responses

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

405

Method Not Allowed

409

Conflict

415

Bad Media Type

500

Internal Server Error

501

Not Implemented

put/{tenant_id}/servers/{server_id}/uefi
https://{api_endpoint}/v2/{tenant_id}/servers/{server_id}/uefi

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "uefi":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "badRequest":
    {
    }
}

Versions

The following API manages to get supported API versions.

Show Version 2 information

Show Baremetal Server API version.

Responses

200

OK

401

Unauthorized

405

Method Not Allowed

415

Bad Media Type

500

Internal Server Error

get/v2
https://{api_endpoint}/v2

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{}

List Versions information

List Baremetal Server API versions. Now, supported version is only 2.

Responses

200

OK

401

Unauthorized

405

Method Not Allowed

415

Bad Media Type

500

Internal Server Error

get/
https://{api_endpoint}/

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{}