This is the multi-page printable view of this section. Click here to print.
Create Virtual Server
1 - 1.3
scp-cli virtualserver server create
--volumes <value>
--server_type_id <value>
--networks <value>
--name <value>
--keypair_name <value>
--image_id <value>
[--file_storage_ids <value>]
[--lock <value>]
[--max_count <value>]
[--metadata <value>]
[--partition_number <value>]
[--product_category <value>]
[--product_offering <value>]
[--security_groups <value>]
[--server_group_id <value>]
[--tags <value>]
[--user_data <value>]
Description
Create Virtual Server.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volumes required | array | Volumes | '{"boot_index": 0, "delete_on_termination": false, "max_iops": 10000, "max_throughput": 500, "size": 104, "source_type": "image", "type": "SSD"}' |
| server_type_id required | string | Server type ID | s1v1m2 |
| networks required | array | List of Network | '{"fixed_ip": "192.169.3.2", "port_id": "91424c08-0b26-49fb-9808-ed042292ceef", "public_ip_id": "615fa9cd5cff486c9de679b3ce63e601", "subnet_id": "78b2ee3f074145c580ab6abac4821f97"}' |
| name required | string | Server name | servername |
| keypair_name required | string | Keypair name | keypairname |
| image_id required | string | Image ID | 70a599e0-31e7-49b7-b260-868f441e862b |
| file_storage_ids optional | array | File Storage ID list | 96d258ea-dd5d-4cca-bb3a-b6909b7e2065 |
| lock optional | boolean | Sets the server's lock status. When the server is locked, most user actions are not allowed. | False |
| max_count optional | integer | Maximum number of servers to launch. | 2 |
| metadata optional | object | User can specify custom server metadata as a set of key-value pairs. | - |
| partition_number optional | integer | Sets the target partition number for server creation. only usable if server group type is partition. | 1 |
| product_category optional | **** | Product category | compute |
| product_offering optional | **** | Product offering | virtual_server |
| security_groups optional | array | Security Groups | c09c3f05-03d9-443f-b27a-40e0f973c75f |
| server_group_id optional | string | Server Group ID | 616fb98f-46ca-475e-917e-2563e5a8cd19 |
| tags optional | array | Tags | '{"key": "Key", "value": "Value"}' |
| user_data optional | string | Script or configuration to run when the server starts. it must be Base64-encoded string and must not exceed 65535 bytes. | IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg== |
Responses
| Name | Description | Example |
|---|---|---|
| id | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
2 - 1.2
scp-cli virtualserver server create
--volumes <value>
--server_type_id <value>
--networks <value>
--name <value>
--keypair_name <value>
--image_id <value>
[--file_storage_ids <value>]
[--lock <value>]
[--max_count <value>]
[--metadata <value>]
[--partition_number <value>]
[--product_category <value>]
[--product_offering <value>]
[--security_groups <value>]
[--server_group_id <value>]
[--tags <value>]
[--user_data <value>]
Description
Create Virtual Server.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20260831 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volumes required | array | Volumes | '{"boot_index": 0, "delete_on_termination": false, "max_iops": 10000, "max_throughput": 500, "size": 104, "source_type": "image", "type": "SSD"}' |
| server_type_id required | string | Server type ID | s1v1m2 |
| networks required | array | List of Network | '{"fixed_ip": "192.169.3.2", "port_id": "91424c08-0b26-49fb-9808-ed042292ceef", "public_ip_id": "615fa9cd5cff486c9de679b3ce63e601", "subnet_id": "78b2ee3f074145c580ab6abac4821f97"}' |
| name required | string | Server name | servername |
| keypair_name required | string | Keypair name | keypairname |
| image_id required | string | Image ID | 70a599e0-31e7-49b7-b260-868f441e862b |
| file_storage_ids optional | array | File Storage ID list | 96d258ea-dd5d-4cca-bb3a-b6909b7e2065 |
| lock optional | boolean | Sets the server's lock status. When the server is locked, most user actions are not allowed. | False |
| max_count optional | integer | Maximum number of servers to launch. | 2 |
| metadata optional | object | User can specify custom server metadata as a set of key-value pairs. | - |
| partition_number optional | integer | Sets the target partition number for server creation. only usable if server group type is partition. | 1 |
| product_category optional | **** | Product category | compute |
| product_offering optional | **** | Product offering | virtual_server |
| security_groups optional | array | Security Groups | c09c3f05-03d9-443f-b27a-40e0f973c75f |
| server_group_id optional | string | Server Group ID | 616fb98f-46ca-475e-917e-2563e5a8cd19 |
| tags optional | array | Tags | '{"key": "Key", "value": "Value"}' |
| user_data optional | string | Script or configuration to run when the server starts. it must be Base64-encoded string and must not exceed 65535 bytes. | IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg== |
Responses
| Name | Description | Example |
|---|---|---|
| id | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
3 - 1.1
scp-cli virtualserver server create
--server_type_id <value>
--networks <value>
--name <value>
--keypair_name <value>
--image_id <value>
[--lock <value>]
[--max_count <value>]
[--metadata <value>]
[--partition_number <value>]
[--product_category <value>]
[--product_offering <value>]
[--security_groups <value>]
[--server_group_id <value>]
[--tags <value>]
[--user_data <value>]
[--volumes <value>]
Description
Create Virtual Server.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_type_id required | string | Server type ID | s1v1m2 |
| networks required | array | List of Network | '{"fixed_ip": "192.169.3.2", "port_id": "91424c08-0b26-49fb-9808-ed042292ceef", "public_ip_id": "615fa9cd5cff486c9de679b3ce63e601", "subnet_id": "78b2ee3f074145c580ab6abac4821f97"}' |
| name required | string | Server name | servername |
| keypair_name required | string | Keypair name | keypairname |
| image_id required | string | Image ID | 70a599e0-31e7-49b7-b260-868f441e862b |
| lock optional | boolean | Sets the server's lock status. When the server is locked, most user actions are not allowed. | False |
| max_count optional | integer | Maximum number of servers to launch. | 2 |
| metadata optional | object | User can specify custom server metadata as a set of key-value pairs. | - |
| partition_number optional | integer | Sets the target partition number for server creation. only usable if server group type is partition. | 1 |
| product_category optional | **** | Product category | compute |
| product_offering optional | **** | Product offering | virtual_server |
| security_groups optional | array | Security Groups | c09c3f05-03d9-443f-b27a-40e0f973c75f |
| server_group_id optional | string | Server Group ID | 616fb98f-46ca-475e-917e-2563e5a8cd19 |
| tags optional | array | Tags | '{"key": "Key", "value": "Value"}' |
| user_data optional | string | Script or configuration to run when the server starts. it must be Base64-encoded string and must not exceed 65535 bytes. | IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg== |
| volumes optional | array | Volumes | '{"boot_index": 0, "delete_on_termination": false, "size": 104, "source_type": "image", "type": "SSD"}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
4 - 1.0
scp-cli virtualserver server create
--server_type_id <value>
--networks <value>
--name <value>
--keypair_name <value>
--image_id <value>
[--lock <value>]
[--max_count <value>]
[--metadata <value>]
[--partition_number <value>]
[--product_category <value>]
[--product_offering <value>]
[--security_groups <value>]
[--server_group_id <value>]
[--tags <value>]
[--user_data <value>]
[--volumes <value>]
Description
Create Virtual Server.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_type_id required | string | Server type ID | s1v1m2 |
| networks required | array | List of Network | '{"fixed_ip": "192.169.3.2", "port_id": "91424c08-0b26-49fb-9808-ed042292ceef", "public_ip_id": "615fa9cd5cff486c9de679b3ce63e601", "subnet_id": "78b2ee3f074145c580ab6abac4821f97"}' |
| name required | string | Server name | servername |
| keypair_name required | string | Keypair name | keypairname |
| image_id required | string | Image ID | 70a599e0-31e7-49b7-b260-868f441e862b |
| lock optional | boolean | Sets the server's lock status. When the server is locked, most user actions are not allowed. | False |
| max_count optional | integer | Maximum number of servers to launch. | 2 |
| metadata optional | object | User can specify custom server metadata as a set of key-value pairs. | - |
| partition_number optional | integer | Sets the target partition number for server creation. only usable if server group type is partition. | 1 |
| product_category optional | **** | Product category | compute |
| product_offering optional | **** | Product offering | virtual_server |
| security_groups optional | array | Security Groups | c09c3f05-03d9-443f-b27a-40e0f973c75f |
| server_group_id optional | string | Server Group ID | 616fb98f-46ca-475e-917e-2563e5a8cd19 |
| tags optional | array | Tags | '{"key": "Key", "value": "Value"}' |
| user_data optional | string | Script or configuration to run when the server starts. it must be Base64-encoded string and must not exceed 65535 bytes. | IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg== |
| volumes optional | array | Volumes | '{"boot_index": 0, "delete_on_termination": false, "size": 104, "source_type": "image", "type": "SSD"}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |