Server

List all servers

get

Returns all bare metal servers in the specified project and region.

Required scopes

This endpoint requires the following scopes:

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

vpc_idstringRequired

The unique identifier of the VPC where the server belongs

Query parameters

pageinteger · int32 · min: 1Optional

The page number for pagination.

pageSizeinteger · int32 · min: 1Optional

The number of items per page.

Responses

200

List Server

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

get

/api/v2/vmware/vpc/{vpc_id}/hpc/server/list

HTTPcURLJavaScriptPython

GET /api/v2/vmware/vpc/{vpc_id}/hpc/server/list HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": "text",
      "status": "text",
      "created_at": "text",
      "updated_at": "text",
      "vpc_id": "text",
      "name": "text",
      "private_ip": "text",
      "public_ip": "text",
      "network_name": "text",
      "network_id": "text",
      "os": "text",
      "distro": "text",
      "hpc_server_type": "text",
      "meta_data": "text",
      "port_id": "text",
      "time_stamp": "text"
    }
  ],
  "total": 1,
  "isSuccess": true,
  "error": "text"
}

Get server details

get

Required scopes

This endpoint requires the following scopes:

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

vpc_idstringRequired

The unique identifier of the VPC where the server belongs.

server_idstringRequired

The unique identifier of server

Responses

200

Detail about server that have server id

application/json

400Error

401Error

404Error

500Error

get

/api/v2/vmware/vpc/{vpc_id}/hpc/server/{server_id}/detail

HTTPcURLJavaScriptPython

GET /api/v2/vmware/vpc/{vpc_id}/hpc/server/{server_id}/detail HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "message": "text",
  "data": {
    "id": "text",
    "status": "text",
    "created_at": "text",
    "updated_at": "text",
    "vpc_id": "text",
    "name": "text",
    "private_ip": "text",
    "public_ip": "text",
    "network_name": "text",
    "network_id": "text",
    "os": "text",
    "distro": "text",
    "hpc_server_type": "text",
    "meta_data": "text",
    "port_id": "text",
    "time_stamp": "text"
  }
}

Get server console URL

get

Get the URL of the bare metal server to access the server via KVM console. Refers to https://fptcloud.com/en/documents/metal-cloud/?doc=access-server

Required scopes

This endpoint requires the following scopes:

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

vpc_idstringRequired

The unique identifier of the VPC where the server belongs.

Example: a224d558-7b63-4706-ab9d-b2ed68477fa6

server_idstringRequired

The unique identifier of the server to manage in the FPT Cloud console.

Responses

200

Get console url for that server id

application/json

400Error

401Error

404Error

500Error

get

/api/v2/vmware/vpc/{vpc_id}/hpc/server/{server_id}/console

HTTPcURLJavaScriptPython

GET /api/v2/vmware/vpc/{vpc_id}/hpc/server/{server_id}/console HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": {
    "console_url": "text"
  },
  "message": "text"
}

Create server (V2)

post

You can create one or multiple servers using the following configuration options:

Parameter	Type	Required	Description
server_pack	string	✅	The flavor of the server pack to use. Selection depends on your region and quota.
names	array[string]	✅	A list of unique server names within a VPC. The number of names determines how many servers will be created. Each name must match the regex pattern defined in SERVER_NAME_REGEX.
os	string	✅	The OS image type. Must be either: - custom: For your own custom images - ubuntu: For FPT public images
distro	object	✅	The selected OS image in JSON format. Example: json<br/>{ "name": "ubuntu", "title": "Ubuntu 20.04" }<br/>
network_id	string	✅	The subnet ID to associate with the server.
sshkey	object	✅	SSH key details in JSON format. Example: json<br/>{ "name": "key_name", "public_key": "ssh-rsa..." }<br/> Default username: clouduser
console_password	string	❌	The password to log in and access the server via SSH. Must match the regex defined in PASSWORD_CONSOLE_REGEX. Default username: clouduser
user_data	string	❌	User data scripts executed automatically on first boot using the cloud-init process.
floating_ip	boolean	❌	Attach a public IP to the server. Defaults to false.
raid_type	string	❌	RAID disk configuration. Supported values: - raid-0 - raid-1 - raid-5 - raid-6
mount_point	string	❌	Mount point path for attaching high-performance (file) storage to the server.

Required scopes

This endpoint requires the following scopes:

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

vpc_idstringRequired

Body

application/json

server_packstring · uuidRequired

UUID of the server flavor.

namesstring[] · min: 1 · max: 63Required

List server names. Each name must match the regex defined in SERVER_NAME_REGEX.

osstringRequired

The OS image type. Must be either:custom for your own custom images ubuntu for FPT public images

distrostring · min: 1Required

The selected OS image in JSON format. e.g., {"name": "ubuntu", "title": "Ubuntu 20.04"} The name is required.

network_idstring · uuidRequired

UUID of a subnet to which the server will be associated.

sshkeystring · nullableOptional

SSH key details in JSON format (e.g., {"name": "key_name", "public_key": "ssh-rsa..."}). Default username is clouduser

console_passwordstring · nullableOptional

Password to access the server via SSH. Must match the regex defined in PASSWORD_CONSOLE_REGEX. Default username is: clouduser

user_datastring · nullableOptional

User data for cloud-init configuration.

floating_ipbooleanOptional

Whether a floating IP will be assigned to the server. Defaults to false.

raid_typestring · nullableOptional

RAID configuration for the server. Supported values are raid-0, raid-1, raid-5, and raid-6.

mount_pointstring · nullableOptional

Mount point for the server's storage.

Responses

201

Created successfully

application/json

400Error

401Error

404Error

500Error

post

/api/v2/vmware/vpc/{vpc_id}/hpc/server

HTTPcURLJavaScriptPython

POST /api/v2/vmware/vpc/{vpc_id}/hpc/server HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 429

{
  "names": [
    "server1",
    "server2"
  ],
  "raidType": "raid-1",
  "serverPack": "123e4567-e89b-12d3-a456-426614174000",
  "os": "ubuntu",
  "distro": "{\"name\": \"ubuntu\", \"title\": \"Ubuntu 20.04\"}",
  "networkId": "123e4567-e89b-12d3-a456-426614174001",
  "sshKey": "{\"name\": \"key_name\", \"public_key\": \"ssh-rsa AAAAB3...\"}",
  "consolePassword": "P@ssw0rd123",
  "userData": "#cloud-config\npackages:\n - nginx",
  "floatingIp": true,
  "mountPoint": "/mnt/data"
}

{
  "data": [],
  "message": null
}

Deprecated

Create server (V1)

post

You can create one or multiple servers using the following configuration options:

Parameter	Type	Required	Description
serverPack	string	✅	The flavor of the server pack to use. Selection depends on your region and quota.
names	array[string]	✅	A list of unique server names within a VPC. The number of names determines how many servers will be created. Each name must match the regex pattern defined in SERVER_NAME_REGEX.
os	string	✅	The OS image type. Must be either: - custom: For your own custom images - ubuntu: For FPT public images
distro	object	✅	The selected OS image in JSON format. Example: json<br/>{ "name": "ubuntu", "title": "Ubuntu 20.04" }<br/>
networkId	string	✅	The subnet ID to associate with the server.
sshKey	object	✅	SSH key details in JSON format. Example: json<br/>{ "name": "key_name", "public_key": "ssh-rsa..." }<br/> Default username: clouduser
consolePassword	string	❌	The password to log in and access the server via SSH. Must match the regex defined in PASSWORD_CONSOLE_REGEX. Default username: clouduser
userData	string	❌	User data scripts executed automatically on first boot using the cloud-init process.
floatingIp	boolean	❌	Attach a public IP to the server. Defaults to false.
raidType	string	❌	RAID disk configuration. Supported values: - raid-0 - raid-1 - raid-5 - raid-6
mountPoint	string	❌	Mount point path for attaching high-performance (file) storage to the server.

Required scopes

This endpoint requires the following scopes:

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

vpc_idstringRequired

Body

application/json

namesstring[] · min: 1 · max: 63Required

List of server names. Each name must match the regex defined in SERVER_NAME_REGEX.

raidTypestring · nullableOptional

RAID configuration for the server. Supported values are raid-0, raid-1, raid-5, and raid-6.

serverPackstring · uuidRequired

UUID of the server type.

osstringRequired

OS image type for the server. Must be either custom or ubuntu.

distrostring · min: 1Required

Image name (distribution details) in JSON format (e.g., {"name": "ubuntu", "title": "Ubuntu 20.04"}).

networkIdstring · uuidRequired

UUID of the network to which the server will be connected.

sshKeystring · nullableOptional

SSH key details in JSON format (e.g., {"name": "key_name", "public_key": "ssh-rsa..."}). Default username is: clouduser

consolePasswordstring · nullableOptional

Console password for the server. Must match the regex defined in PASSWORD_CONSOLE_REGEX. Default username is: clouduser

userDatastring · nullableOptional

User data for cloud-init configuration.

floatingIpbooleanOptional

Whether a floating IP will be assigned to the server. Defaults to false.

mountPointstring · nullableOptional

Mount point for the server's storage.

Responses

201

Created successfully

application/json

400Error

401Error

404Error

500Error

post

/api/v2/vmware/vpc/{vpc_id}/hpc/server/create

HTTPcURLJavaScriptPython

POST /api/v2/vmware/vpc/{vpc_id}/hpc/server/create HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 429

{
  "names": [
    "server1",
    "server2"
  ],
  "raidType": "raid-1",
  "serverPack": "123e4567-e89b-12d3-a456-426614174000",
  "os": "ubuntu",
  "distro": "{\"name\": \"ubuntu\", \"title\": \"Ubuntu 20.04\"}",
  "networkId": "123e4567-e89b-12d3-a456-426614174001",
  "sshKey": "{\"name\": \"key_name\", \"public_key\": \"ssh-rsa AAAAB3...\"}",
  "consolePassword": "P@ssw0rd123",
  "userData": "#cloud-config\npackages:\n - nginx",
  "floatingIp": true,
  "mountPoint": "/mnt/data"
}

{
  "data": [],
  "message": null
}

Rename a server (Portal name)

post

Change the display name of a specified server in the FPT Cloud console. Name limits up to 63 characters, and only letters, numbers, and dashes are allowed

Required scopes

This endpoint requires the following scopes:

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

server_idstringRequired

The unique identifier of the server to manage in the FPT Cloud console.

Example: a224d558-7b63-4706-ab9d-b2ed68477fa6

vpc_idstringRequired

The unique identifier of the VPC where the server belongs.

Body

application/json

namestringOptional

The new server name.

Responses

200

Update a server successfully

application/json

400Error

401Error

404Error

500Error

post

/api/v2/vmware/vpc/{vpc_id}/hpc/server/{server_id}/rename

HTTPcURLJavaScriptPython

POST /api/v2/vmware/vpc/{vpc_id}/hpc/server/{server_id}/rename HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}

{
  "isSuccess": true,
  "error": "text"
}

Power on a server

post

Start a powered-off server.

Required scopes

This endpoint requires the following scopes:

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

server_idstringRequired

The unique identifier of the server to manage in the FPT Cloud console.

vpc_idstringRequired

The unique identifier of the VPC where the server belongs.

Example: a224d558-7b63-4706-ab9d-b2ed68477fa6

Responses

202

Power on server request is accepted

application/json

400Error

401Error

404Error

500Error

post

/api/v2/vmware/vpc/{vpc_id}/hpc/server/{server_id}/powered-on

HTTPcURLJavaScriptPython

POST /api/v2/vmware/vpc/{vpc_id}/hpc/server/{server_id}/powered-on HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": {},
  "message": "text"
}

Power off a server

post

Shut down the running server.

Required scopes

This endpoint requires the following scopes:

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

server_idstringRequired

The unique identifier of the server to manage in the FPT Cloud console.

vpc_idstringRequired

The unique identifier of the VPC where the server belongs.

Example: a224d558-7b63-4706-ab9d-b2ed68477fa6

Responses

202

Power off server request is accepted

application/json

400Error

401Error

404Error

500Error

post

/api/v2/vmware/vpc/{vpc_id}/hpc/server/{server_id}/powered-off

HTTPcURLJavaScriptPython

POST /api/v2/vmware/vpc/{vpc_id}/hpc/server/{server_id}/powered-off HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": {},
  "message": "text"
}

Delete a server

delete

Deleting a server permanently erases all data on its disks and cannot be undone. Ensure you are deleting the correct server.

Required scopes

This endpoint requires the following scopes:

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

vpc_idstringRequired

The unique identifier of the VPC where the server belongs.

Example: a224d558-7b63-4706-ab9d-b2ed68477fa6

server_idstringRequired

The unique identifier of the server to manage in the FPT Cloud console.

Body

application/json

isReleaseFloatingIpbooleanOptional

True: Allows deleting the server along with its associated public IP. False: Deletes the server but retains the public IP.

Responses

202

Delete request be accepted

application/json

400Error

401Error

404Error

500Error

delete

/api/v2/vmware/vpc/{vpc_id}/hpc/server/{server_id}

HTTPcURLJavaScriptPython

DELETE /api/v2/vmware/vpc/{vpc_id}/hpc/server/{server_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "isReleaseFloatingIp": true
}

{
  "data": {},
  "message": "text"
}