Virtual Server
Overview
Provides an Application Programming Interface (API) that supports programmatic use of IaaS/PaaS products provided by SCP.
This guide provides a brief description of Virtual Server service and how to call API.
The API is provided as a RESTful API, and it responds in JSON format.
Version
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Status | Not Before |
|---|
| 1.2 | CURRENT | - |
| 1.1 | DEPRECATED | 20260531 |
| 1.0 | DEPRECATED | 20251231 |
OpenAPI URL
https://virtualserver.{region}.{environment}.samsungsdscloud.com
Environment and Region List
| environment | region |
|---|
| s | kr-west1 |
| s | kr-east1 |
| g | kr-south1 |
| g | kr-south2 |
| g | kr-south3 |
| e | kr-west1 |
| e | kr-east1 |
1 - APIs
1.1 - Accept a volume transfer
1.1.1 - 1.2
post /v1/volume-transfer/{transfer_id}/accept
Description
Accept a volume transfer.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | transfer_id
required | Volume Transfer ID
Example : 1ac231be-823b-4a4d-8ff0-aac503a7118a
| string | None |
| body | body
required |
| VolumeTransferAcceptRequest | |
Responses
Example HTTP request
Request path
/v1/volume-transfer/{transfer_id}/accept
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"auth_key": "f5972fdb456897eb"
}
Example HTTP response
Response 202
{
"id": "1ac231be-823b-4a4d-8ff0-aac503a7118a",
"name": "volume01",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
1.1.2 - 1.1
post /v1/volume-transfer/{transfer_id}/accept
Description
Accept a volume transfer.
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
| Type | Name | Description | Schema | Default |
|---|
| path | transfer_id
required | Volume Transfer ID
Example : 1ac231be-823b-4a4d-8ff0-aac503a7118a
| string | None |
| body | body
required |
| VolumeTransferAcceptRequest | |
Responses
Example HTTP request
Request path
/v1/volume-transfer/{transfer_id}/accept
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"auth_key": "f5972fdb456897eb"
}
Example HTTP response
Response 202
{
"id": "1ac231be-823b-4a4d-8ff0-aac503a7118a",
"name": "volume01",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
1.1.3 - 1.0
post /v1/volume-transfer/{transfer_id}/accept
Description
Accept a volume transfer.
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
| Type | Name | Description | Schema | Default |
|---|
| path | transfer_id
required | Volume Transfer ID
Example : 1ac231be-823b-4a4d-8ff0-aac503a7118a
| string | None |
| body | body
required |
| VolumeTransferAcceptRequest | |
Responses
Example HTTP request
Request path
/v1/volume-transfer/{transfer_id}/accept
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"auth_key": "f5972fdb456897eb"
}
Example HTTP response
Response 202
{
"id": "1ac231be-823b-4a4d-8ff0-aac503a7118a",
"name": "volume01",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
1.2 - Attach Virtual Server Security Group
1.2.1 - 1.0
post /v1/servers/{server_id}/security-groups
Description
Attach Virtual Server Security Group.
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
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/security-groups
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"security_group_id": "c09c3f05-03d9-443f-b27a-40e0f973c75f"
}
Example HTTP response
Response 202
1.3 - Attach Volume to Virtual Server
1.3.1 - 1.2
post /v1/volumes/{volume_id}/servers
Description
Attach Volume to Virtual Server.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume ID
Example : 3f500f00-ed80-4566-a057-e31760226f9a
| string | None |
| body | body
required |
| VolumeServerAttachRequest | |
Responses
Example HTTP request
Request path
/v1/volumes/{volume_id}/servers
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"delete_on_termination": false,
"server_id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
}
Example HTTP response
Response 202
{
"delete_on_termination": false,
"device": "/dev/vda",
"server_id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
1.3.2 - 1.1
post /v1/volumes/{volume_id}/servers
Description
Attach Volume to 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
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume ID
Example : 3f500f00-ed80-4566-a057-e31760226f9a
| string | None |
| body | body
required |
| VolumeServerAttachRequest | |
Responses
Example HTTP request
Request path
/v1/volumes/{volume_id}/servers
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"delete_on_termination": false,
"server_id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
}
Example HTTP response
Response 202
{
"delete_on_termination": false,
"device": "/dev/vda",
"server_id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
1.3.3 - 1.0
post /v1/volumes/{volume_id}/servers
Description
Attach Volume to 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
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume ID
Example : 3f500f00-ed80-4566-a057-e31760226f9a
| string | None |
| body | body
required |
| VolumeServerAttachRequest | |
Responses
Example HTTP request
Request path
/v1/volumes/{volume_id}/servers
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"delete_on_termination": false,
"server_id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
}
Example HTTP response
Response 202
{
"delete_on_termination": false,
"device": "/dev/vda",
"server_id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
1.4 - Create a snapshot
1.4.1 - 1.2
post /v1/snapshots
Description
Create a volume snapshot. This snapshot is a full copy of the volume. You can create a volume from the snapshot that was created.
State
ACTIVE (CURRENT)
Parameters
Responses
Example HTTP request
Request path
/v1/snapshots
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"description": "description",
"force": true,
"metadata": "",
"name": "snapshot-1",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
Example HTTP response
Response 202
{
"created_at": "2025-07-22T09:00:00Z",
"description": "description",
"id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"metadata": "Metadata",
"name": "snapshot-1",
"size": 104,
"status": "available",
"updated_at": "2025-07-26T12:00:00Z",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
1.4.2 - 1.1
post /v1/snapshots
Description
Create a volume snapshot. This snapshot is a full copy of the volume. You can create a volume from the snapshot that was created.
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
Responses
Example HTTP request
Request path
/v1/snapshots
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"description": "description",
"force": true,
"metadata": "",
"name": "snapshot-1",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
Example HTTP response
Response 202
{
"created_at": "2025-07-22T09:00:00Z",
"description": "description",
"id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"metadata": "Metadata",
"name": "snapshot-1",
"size": 104,
"status": "available",
"updated_at": "2025-07-26T12:00:00Z",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
1.4.3 - 1.0
post /v1/snapshots
Description
Create a volume snapshot. This snapshot is a full copy of the volume. You can create a volume from the snapshot that was created.
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
Responses
Example HTTP request
Request path
/v1/snapshots
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"description": "description",
"force": true,
"metadata": "",
"name": "snapshot-1",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
Example HTTP response
Response 202
{
"created_at": "2025-07-22T09:00:00Z",
"description": "description",
"id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"metadata": "Metadata",
"name": "snapshot-1",
"size": 104,
"status": "available",
"updated_at": "2025-07-26T12:00:00Z",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
1.5 - Create a volume transfer
1.5.1 - 1.2
post /v1/volume-transfer
Description
Create a volume transfer.
State
ACTIVE (CURRENT)
Parameters
Responses
Example HTTP request
Request path
/v1/volume-transfer
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"name": "volume01",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
Example HTTP response
Response 202
{
"auth_key": "f5972fdb456897eb",
"created_at": "",
"id": "1ac231be-823b-4a4d-8ff0-aac503a7118a",
"name": "volume01",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
1.5.2 - 1.1
post /v1/volume-transfer
Description
Create a volume transfer.
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
Responses
Example HTTP request
Request path
/v1/volume-transfer
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"name": "volume01",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
Example HTTP response
Response 202
{
"auth_key": "f5972fdb456897eb",
"created_at": "",
"id": "1ac231be-823b-4a4d-8ff0-aac503a7118a",
"name": "volume01",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
1.5.3 - 1.0
post /v1/volume-transfer
Description
Create a volume transfer.
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
Responses
Example HTTP request
Request path
/v1/volume-transfer
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"name": "volume01",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
Example HTTP response
Response 202
{
"auth_key": "f5972fdb456897eb",
"created_at": "",
"id": "1ac231be-823b-4a4d-8ff0-aac503a7118a",
"name": "volume01",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
1.6 - Create Auto-Scaling Group
1.6.1 - 1.2
post /v1/auto-scaling-groups
Description
Create Auto-Scaling Group.
State
ACTIVE (CURRENT)
Parameters
Responses
Example HTTP request
Request path
/v1/auto-scaling-groups
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"desired_server_count": 1,
"desired_server_count_editable": true,
"drain_enabled": true,
"drain_timeout": 300,
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"lb_server_groups": [],
"max_server_count": 2,
"min_server_count": 1,
"name": "auto-scaling-group-name",
"notifications": [],
"scaling_policies": [],
"security_group_ids": [
"c09c3f05-03d9-443f-b27a-40e0f973c75f"
],
"server_name_prefix": "server-name-prefix",
"state_check_delay_time": 300,
"subnet_ids": [
""
],
"tags": [
{
"key": "key",
"value": "value"
}
],
"use_lb_state_check": true
}
Example HTTP response
Response 201
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"desired_server_count": 1,
"desired_server_count_editable": true,
"drain_enabled": true,
"drain_timeout": 300,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"launch_configuration_name": "launch-configuration-name",
"lb_server_groups": [],
"max_server_count": 2,
"min_server_count": 1,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "auto-scaling-group-name",
"security_group_ids": [
"c09c3f05-03d9-443f-b27a-40e0f973c75f"
],
"server_name_prefix": "server-name-prefix",
"state": "IN_SERVICE",
"state_check_delay_time": 300,
"subnet_ids": [],
"total_server_count": 1,
"use_lb_state_check": true,
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
1.6.2 - 1.1
post /v1/auto-scaling-groups
Description
Create Auto-Scaling Group.
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
Responses
Example HTTP request
Request path
/v1/auto-scaling-groups
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"desired_server_count": 1,
"desired_server_count_editable": true,
"drain_enabled": true,
"drain_timeout": 300,
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"lb_server_groups": [],
"max_server_count": 2,
"min_server_count": 1,
"name": "auto-scaling-group-name",
"notifications": [],
"scaling_policies": [],
"security_group_ids": [
"c09c3f05-03d9-443f-b27a-40e0f973c75f"
],
"server_name_prefix": "server-name-prefix",
"subnet_ids": [
""
],
"tags": [
{
"key": "key",
"value": "value"
}
]
}
Example HTTP response
Response 201
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"desired_server_count": 1,
"desired_server_count_editable": true,
"drain_enabled": true,
"drain_timeout": 300,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"launch_configuration_name": "launch-configuration-name",
"lb_server_groups": [],
"max_server_count": 2,
"min_server_count": 1,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "auto-scaling-group-name",
"security_group_ids": [
"c09c3f05-03d9-443f-b27a-40e0f973c75f"
],
"server_name_prefix": "server-name-prefix",
"state": "IN_SERVICE",
"subnet_ids": [],
"total_server_count": 1,
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
1.6.3 - 1.0
post /v1/auto-scaling-groups
Description
Create Auto-Scaling Group.
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
Responses
Example HTTP request
Request path
/v1/auto-scaling-groups
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"desired_server_count": 1,
"desired_server_count_editable": true,
"drain_enabled": true,
"drain_timeout": 300,
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"lb_server_groups": [],
"max_server_count": 2,
"min_server_count": 1,
"name": "auto-scaling-group-name",
"notifications": [],
"scaling_policies": [],
"security_group_ids": [
"c09c3f05-03d9-443f-b27a-40e0f973c75f"
],
"server_name_prefix": "server-name-prefix",
"subnet_ids": [
""
],
"tags": [
{
"key": "key",
"value": "value"
}
]
}
Example HTTP response
Response 201
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"desired_server_count": 1,
"desired_server_count_editable": true,
"drain_enabled": true,
"drain_timeout": 300,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"launch_configuration_name": "launch-configuration-name",
"lb_server_groups": [],
"max_server_count": 2,
"min_server_count": 1,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "auto-scaling-group-name",
"security_group_ids": [
"c09c3f05-03d9-443f-b27a-40e0f973c75f"
],
"server_name_prefix": "server-name-prefix",
"state": "IN_SERVICE",
"subnet_ids": [],
"total_server_count": 1,
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
1.7 - Create Auto-Scaling Group Notification
1.7.1 - 1.2
post /v1/auto-scaling-groups/{auto_scaling_group_id}/notifications
Description
Create Auto-Scaling Group notification.
State
ACTIVE (CURRENT)
Parameters
Responses
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/notifications
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"notification_events": [
"SCALE_OUT",
"SCALE_OUT_FAIL"
],
"user_ids": [
"570907805e5447be84b618450ef52o0t"
]
}
Example HTTP response
Response 201
{
"count": 20,
"notifications": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"notification_events": [
"SCALE_OUT",
"SCALE_OUT_FAIL"
],
"notification_state": "ACTIVE",
"user_email": "scpuser@samsung.com",
"user_id": "570907805e5447be84b618450ef52o0t",
"user_name": "scpuser"
}
]
}
1.7.2 - 1.1
post /v1/auto-scaling-groups/{auto_scaling_group_id}/notifications
Description
Create Auto-Scaling Group notification.
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
Responses
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/notifications
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"notification_events": [
"SCALE_OUT",
"SCALE_OUT_FAIL"
],
"user_ids": [
"570907805e5447be84b618450ef52o0t"
]
}
Example HTTP response
Response 201
{
"count": 20,
"notifications": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"notification_events": [
"SCALE_OUT",
"SCALE_OUT_FAIL"
],
"notification_state": "ACTIVE",
"user_email": "scpuser@samsung.com",
"user_id": "570907805e5447be84b618450ef52o0t",
"user_name": "scpuser"
}
]
}
1.7.3 - 1.0
post /v1/auto-scaling-groups/{auto_scaling_group_id}/notifications
Description
Create Auto-Scaling Group notification.
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
Responses
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/notifications
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"notification_events": [
"SCALE_OUT",
"SCALE_OUT_FAIL"
],
"user_ids": [
"570907805e5447be84b618450ef52o0t"
]
}
Example HTTP response
Response 201
{
"count": 20,
"notifications": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"notification_events": [
"SCALE_OUT",
"SCALE_OUT_FAIL"
],
"notification_state": "ACTIVE",
"user_email": "scpuser@samsung.com",
"user_id": "570907805e5447be84b618450ef52o0t",
"user_name": "scpuser"
}
]
}
1.8 - Create Auto-Scaling Group Policy
1.8.1 - 1.2
post /v1/auto-scaling-groups/{auto_scaling_group_id}/policies
Description
Create Auto-Scaling Group policy.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | None |
| body | body
required |
| AutoScalingGroupPolicyCreateRequest | |
Responses
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/policies
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"comparison_operator": "ge",
"cooldown_seconds": 300,
"evaluation_minutes": 5,
"metric_method": "AVG",
"metric_type": "CPU",
"name": "policy-name",
"scale_method": "AMOUNT",
"scale_type": "SCALE_OUT",
"scale_value": 10,
"threshold": 60
}
Example HTTP response
Response 201
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"comparison_operator": "ge",
"cooldown_seconds": 300,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"evaluation_minutes": 5,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"metric_method": "AVG",
"metric_type": "CPU",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "policy-name",
"scale_method": "AMOUNT",
"scale_type": "SCALE_OUT",
"scale_value": 10,
"state": "ACTIVE",
"threshold": 60,
"threshold_unit": "%"
}
1.8.2 - 1.1
post /v1/auto-scaling-groups/{auto_scaling_group_id}/policies
Description
Create Auto-Scaling Group policy.
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
| Type | Name | Description | Schema | Default |
|---|
| path | auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | None |
| body | body
required |
| AutoScalingGroupPolicyCreateRequest | |
Responses
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/policies
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"comparison_operator": "ge",
"cooldown_seconds": 300,
"evaluation_minutes": 5,
"metric_method": "AVG",
"metric_type": "CPU",
"name": "policy-name",
"scale_method": "AMOUNT",
"scale_type": "SCALE_OUT",
"scale_value": 10,
"threshold": 60
}
Example HTTP response
Response 201
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"comparison_operator": "ge",
"cooldown_seconds": 300,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"evaluation_minutes": 5,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"metric_method": "AVG",
"metric_type": "CPU",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "policy-name",
"scale_method": "AMOUNT",
"scale_type": "SCALE_OUT",
"scale_value": 10,
"state": "ACTIVE",
"threshold": 60,
"threshold_unit": "%"
}
1.8.3 - 1.0
post /v1/auto-scaling-groups/{auto_scaling_group_id}/policies
Description
Create Auto-Scaling Group policy.
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
| Type | Name | Description | Schema | Default |
|---|
| path | auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | None |
| body | body
required |
| AutoScalingGroupPolicyCreateRequest | |
Responses
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/policies
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"comparison_operator": "ge",
"cooldown_seconds": 300,
"evaluation_minutes": 5,
"metric_method": "AVG",
"metric_type": "CPU",
"name": "policy-name",
"scale_method": "AMOUNT",
"scale_type": "SCALE_OUT",
"scale_value": 10,
"threshold": 60
}
Example HTTP response
Response 201
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"comparison_operator": "ge",
"cooldown_seconds": 300,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"evaluation_minutes": 5,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"metric_method": "AVG",
"metric_type": "CPU",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "policy-name",
"scale_method": "AMOUNT",
"scale_type": "SCALE_OUT",
"scale_value": 10,
"state": "ACTIVE",
"threshold": 60,
"threshold_unit": "%"
}
1.9 - Create Auto-Scaling Group Schedule
1.9.1 - 1.2
post /v1/auto-scaling-groups/{auto_scaling_group_id}/schedules
Description
Create Auto-Scaling Group schedule.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | None |
| body | body
required |
| AutoScalingGroupScheduleCreateRequest | |
Responses
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/schedules
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"day_of_month": "-1,1",
"day_of_week": "SU,SA",
"description": "description",
"desired_server_count": 1,
"end_date": "2025-01-01",
"frequency": "WEEKLY",
"hour": 9,
"max_server_count": 2,
"min_server_count": 1,
"minute": 0,
"name": "schedulename",
"start_date": "2024-01-01",
"state": "ACTIVE",
"timezone": "Asia/Seoul"
}
Example HTTP response
Response 201
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"day_of_month": "-1,1",
"day_of_week": "SU,SA",
"description": "description",
"desired_server_count": 1,
"end_date": "2025-01-01",
"frequency": "WEEKLY",
"hour": 9,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"max_server_count": 2,
"min_server_count": 1,
"minute": 0,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "schedulename",
"start_date": "2024-01-01",
"state": "ACTIVE",
"timezone": "Asia/Seoul"
}
1.9.2 - 1.1
post /v1/auto-scaling-groups/{auto_scaling_group_id}/schedules
Description
Create Auto-Scaling Group schedule.
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
| Type | Name | Description | Schema | Default |
|---|
| path | auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | None |
| body | body
required |
| AutoScalingGroupScheduleCreateRequest | |
Responses
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/schedules
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"day_of_month": "-1,1",
"day_of_week": "SU,SA",
"description": "description",
"desired_server_count": 1,
"end_date": "2025-01-01",
"frequency": "WEEKLY",
"hour": 9,
"max_server_count": 2,
"min_server_count": 1,
"minute": 0,
"name": "schedulename",
"start_date": "2024-01-01",
"state": "ACTIVE",
"timezone": "Asia/Seoul"
}
Example HTTP response
Response 201
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"day_of_month": "-1,1",
"day_of_week": "SU,SA",
"description": "description",
"desired_server_count": 1,
"end_date": "2025-01-01",
"frequency": "WEEKLY",
"hour": 9,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"max_server_count": 2,
"min_server_count": 1,
"minute": 0,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "schedulename",
"start_date": "2024-01-01",
"state": "ACTIVE",
"timezone": "Asia/Seoul"
}
1.9.3 - 1.0
post /v1/auto-scaling-groups/{auto_scaling_group_id}/schedules
Description
Create Auto-Scaling Group schedule.
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
| Type | Name | Description | Schema | Default |
|---|
| path | auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | None |
| body | body
required |
| AutoScalingGroupScheduleCreateRequest | |
Responses
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/schedules
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"day_of_month": "-1,1",
"day_of_week": "SU,SA",
"description": "description",
"desired_server_count": 1,
"end_date": "2025-01-01",
"frequency": "WEEKLY",
"hour": 9,
"max_server_count": 2,
"min_server_count": 1,
"minute": 0,
"name": "schedulename",
"start_date": "2024-01-01",
"state": "ACTIVE",
"timezone": "Asia/Seoul"
}
Example HTTP response
Response 201
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"day_of_month": "-1,1",
"day_of_week": "SU,SA",
"description": "description",
"desired_server_count": 1,
"end_date": "2025-01-01",
"frequency": "WEEKLY",
"hour": 9,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"max_server_count": 2,
"min_server_count": 1,
"minute": 0,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "schedulename",
"start_date": "2024-01-01",
"state": "ACTIVE",
"timezone": "Asia/Seoul"
}
1.10 - Create Image
1.10.1 - 1.2
post /v1/images
Description
Create Image.
State
ACTIVE (CURRENT)
Parameters
Responses
Example HTTP request
Request path
/v1/images
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"container_format": "bare",
"disk_format": "qcow2",
"min_disk": 100,
"min_ram": 0,
"name": "imagename",
"os_distro": "alma",
"protected": false,
"tags": [
{
"key": "key",
"value": "value"
}
],
"url": "https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2",
"visibility": "private"
}
Example HTTP response
Response 200
{
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"created_at": "2025-07-22T09:00:00Z",
"disk_format": "qcow2",
"file": "/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file",
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"min_disk": 100,
"min_ram": 0,
"name": "imagename",
"os_distro": "alma",
"os_hash_algo": "sha512",
"os_hash_value": "c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99",
"os_hidden": false,
"owner": "a8f10467abfc4b87b64614ab36eb9ae4",
"owner_account_name": "AccountName",
"owner_user_name": "user@samsung.com",
"protected": false,
"root_device_name": "/dev/vda",
"scp_gpu_driver": "535.183.06",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"scp_os_build_version": "20250101",
"scp_os_version": "8.8",
"size": 2429747200,
"status": "active",
"updated_at": "2025-07-26T12:00:00Z",
"url": "https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2",
"virtual_size": 17179869184,
"visibility": "private",
"volumes": "[{\"tag\": null, \"volume_id\": null, \"encryption_options\": null, \"encryption_secret_uuid\": null, \"encryption_format\": null, \"device_name\": \"/dev/vda\", \"disk_bus\": \"virtio\", \"volume_type\": null, \"encrypted\": null, \"image_id\": null, \"device_type\": \"disk\", \"source_type\": \"snapshot\", \"delete_on_termination\": false, \"volume_size\": 104, \"guest_format\": null, \"boot_index\": 0, \"destination_type\": \"volume\", \"snapshot_id\": \"abde9e38-2ed5-4ecd-b23c-b0120e30690e\", \"no_device\": null}]"
}
1.10.2 - 1.1
post /v1/images
Description
Create Image.
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
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | ImageShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/images
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"container_format": "bare",
"disk_format": "qcow2",
"min_disk": 100,
"min_ram": 0,
"name": "imagename",
"os_distro": "alma",
"protected": false,
"tags": [
{
"key": "key",
"value": "value"
}
],
"url": "https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2",
"visibility": "private"
}
Example HTTP response
Response 200
{
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"created_at": "2025-07-22T09:00:00Z",
"disk_format": "qcow2",
"file": "/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file",
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"min_disk": 100,
"min_ram": 0,
"name": "imagename",
"os_distro": "alma",
"os_hash_algo": "sha512",
"os_hash_value": "c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99",
"os_hidden": false,
"owner": "a8f10467abfc4b87b64614ab36eb9ae4",
"owner_account_name": "AccountName",
"owner_user_name": "user@samsung.com",
"protected": false,
"root_device_name": "/dev/vda",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"scp_os_build_version": "20250101",
"scp_os_version": "8.8",
"size": 2429747200,
"status": "active",
"updated_at": "2025-07-26T12:00:00Z",
"url": "https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2",
"virtual_size": 17179869184,
"visibility": "private",
"volumes": "[{\"tag\": null, \"volume_id\": null, \"encryption_options\": null, \"encryption_secret_uuid\": null, \"encryption_format\": null, \"device_name\": \"/dev/vda\", \"disk_bus\": \"virtio\", \"volume_type\": null, \"encrypted\": null, \"image_id\": null, \"device_type\": \"disk\", \"source_type\": \"snapshot\", \"delete_on_termination\": false, \"volume_size\": 104, \"guest_format\": null, \"boot_index\": 0, \"destination_type\": \"volume\", \"snapshot_id\": \"abde9e38-2ed5-4ecd-b23c-b0120e30690e\", \"no_device\": null}]"
}
1.10.3 - 1.0
post /v1/images
Description
Create Image.
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
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | ImageShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/images
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"container_format": "bare",
"disk_format": "qcow2",
"min_disk": 100,
"min_ram": 0,
"name": "imagename",
"os_distro": "alma",
"protected": false,
"tags": [
{
"key": "key",
"value": "value"
}
],
"url": "https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2",
"visibility": "private"
}
Example HTTP response
Response 200
{
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"created_at": "2025-07-22T09:00:00Z",
"disk_format": "qcow2",
"file": "/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file",
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"min_disk": 100,
"min_ram": 0,
"name": "imagename",
"os_distro": "alma",
"os_hash_algo": "sha512",
"os_hash_value": "c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99",
"os_hidden": false,
"owner": "a8f10467abfc4b87b64614ab36eb9ae4",
"owner_account_name": "AccountName",
"owner_user_name": "user@samsung.com",
"protected": false,
"root_device_name": "/dev/vda",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"scp_os_build_version": "20250101",
"scp_os_version": "8.8",
"size": 2429747200,
"status": "active",
"updated_at": "2025-07-26T12:00:00Z",
"url": "https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2",
"virtual_size": 17179869184,
"visibility": "private",
"volumes": "[{\"tag\": null, \"volume_id\": null, \"encryption_options\": null, \"encryption_secret_uuid\": null, \"encryption_format\": null, \"device_name\": \"/dev/vda\", \"disk_bus\": \"virtio\", \"volume_type\": null, \"encrypted\": null, \"image_id\": null, \"device_type\": \"disk\", \"source_type\": \"snapshot\", \"delete_on_termination\": false, \"volume_size\": 104, \"guest_format\": null, \"boot_index\": 0, \"destination_type\": \"volume\", \"snapshot_id\": \"abde9e38-2ed5-4ecd-b23c-b0120e30690e\", \"no_device\": null}]"
}
1.11 - Create Image member
1.11.1 - 1.2
post /v1/images/{image_id}/members
Description
Add account ID as a shared Image member.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | image_id
required | Image ID
Example : 70a599e0-31e7-49b7-b260-868f441e862b
| string | None |
| body | body
required |
| ImageMemberCreateRequest | |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | ImageMemberShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/images/{image_id}/members
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"member_id": "a8f10467abfc4b87b64614ab36eb9ae4"
}
Example HTTP response
Response 200
{
"created_at": "2025-07-22T09:00:00Z",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"member_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"status": "pending",
"updated_at": "2025-07-26T12:00:00Z"
}
1.11.2 - 1.1
post /v1/images/{image_id}/members
Description
Add account ID as a shared Image member.
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
| Type | Name | Description | Schema | Default |
|---|
| path | image_id
required | Image ID
Example : 70a599e0-31e7-49b7-b260-868f441e862b
| string | None |
| body | body
required |
| ImageMemberCreateRequest | |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | ImageMemberShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/images/{image_id}/members
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"member_id": "a8f10467abfc4b87b64614ab36eb9ae4"
}
Example HTTP response
Response 200
{
"created_at": "2025-07-22T09:00:00Z",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"member_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"status": "pending",
"updated_at": "2025-07-26T12:00:00Z"
}
1.11.3 - 1.0
post /v1/images/{image_id}/members
Description
Add account ID as a shared Image member.
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
| Type | Name | Description | Schema | Default |
|---|
| path | image_id
required | Image ID
Example : 70a599e0-31e7-49b7-b260-868f441e862b
| string | None |
| body | body
required |
| ImageMemberCreateRequest | |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | ImageMemberShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/images/{image_id}/members
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"member_id": "a8f10467abfc4b87b64614ab36eb9ae4"
}
Example HTTP response
Response 200
{
"created_at": "2025-07-22T09:00:00Z",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"member_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"status": "pending",
"updated_at": "2025-07-26T12:00:00Z"
}
1.12 - Create Keypair
1.12.1 - 1.2
post /v1/keypairs
Description
Create a new Keypair or Import a Public Key.
State
ACTIVE (CURRENT)
Parameters
Responses
| HTTP Code | Description | Schema |
|---|
| 201 | Created | KeypairCreateResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/keypairs
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"name": "keypairname",
"public_key": "ssh-rsa fakeKey Generated-by-SCP",
"tags": [
{
"key": "key",
"value": "value"
}
]
}
Example HTTP response
Response 201
{
"fingerprint": "7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd",
"name": "keypairname",
"private_key": "-----BEGIN RSA PRIVATE KEY-----\nfakeKey\n-----END RSA PRIVATE KEY-----",
"public_key": "ssh-rsa fakeKey Generated-by-SCP",
"type": "ssh"
}
1.12.2 - 1.1
post /v1/keypairs
Description
Create a new Keypair or Import a Public Key.
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
Responses
| HTTP Code | Description | Schema |
|---|
| 201 | Created | KeypairCreateResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/keypairs
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"name": "keypairname",
"public_key": "ssh-rsa fakeKey Generated-by-SCP",
"tags": [
{
"key": "key",
"value": "value"
}
]
}
Example HTTP response
Response 201
{
"fingerprint": "7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd",
"name": "keypairname",
"private_key": "-----BEGIN RSA PRIVATE KEY-----\nfakeKey\n-----END RSA PRIVATE KEY-----",
"public_key": "ssh-rsa fakeKey Generated-by-SCP",
"type": "ssh"
}
1.12.3 - 1.0
post /v1/keypairs
Description
Create a new Keypair or Import a Public Key.
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
Responses
| HTTP Code | Description | Schema |
|---|
| 201 | Created | KeypairCreateResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/keypairs
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"name": "keypairname",
"public_key": "ssh-rsa fakeKey Generated-by-SCP",
"tags": [
{
"key": "key",
"value": "value"
}
]
}
Example HTTP response
Response 201
{
"fingerprint": "7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd",
"name": "keypairname",
"private_key": "-----BEGIN RSA PRIVATE KEY-----\nfakeKey\n-----END RSA PRIVATE KEY-----",
"public_key": "ssh-rsa fakeKey Generated-by-SCP",
"type": "ssh"
}
1.13 - Create Launch Configuration
1.13.1 - 1.2
post /v1/launch-configurations
Description
Create Launch Configuration.
State
ACTIVE (CURRENT)
Parameters
Responses
Example HTTP request
Request path
/v1/launch-configurations
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"keypair_name": "keypairname",
"name": "launch-configuration-name",
"server_type_id": "s1v1m2",
"tags": [
{
"key": "key",
"value": "value"
}
],
"user_data": "IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==",
"volumes": [
{
"boot_index": 0,
"size": 104,
"type": "SSD"
}
]
}
Example HTTP response
Response 201
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_count": 1,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"file_storage_ids": [
""
],
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"keypair_name": "keypairname",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "launch-configuration-name",
"public_key": "ssh-rsa fakeKey Generated-by-SCP",
"server_type_id": "s1v1m2",
"state": "ACTIVE",
"user_data": "IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==",
"volumes": [
{
"boot_index": 0,
"max_iops": 10000,
"max_throughput": 500,
"size": 104,
"type": "SSD"
}
]
}
1.13.2 - 1.1
post /v1/launch-configurations
Description
Create Launch Configuration.
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
Responses
Example HTTP request
Request path
/v1/launch-configurations
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"keypair_name": "keypairname",
"name": "launch-configuration-name",
"server_type_id": "s1v1m2",
"tags": [
{
"key": "key",
"value": "value"
}
],
"user_data": "IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==",
"volumes": [
{
"boot_index": 0,
"size": 104,
"type": "SSD"
}
]
}
Example HTTP response
Response 201
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_count": 1,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"keypair_name": "keypairname",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "launch-configuration-name",
"public_key": "ssh-rsa fakeKey Generated-by-SCP",
"server_type_id": "s1v1m2",
"state": "ACTIVE",
"user_data": "IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==",
"volumes": [
{
"boot_index": 0,
"size": 104,
"type": "SSD"
}
]
}
1.13.3 - 1.0
post /v1/launch-configurations
Description
Create Launch Configuration.
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
Responses
Example HTTP request
Request path
/v1/launch-configurations
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"keypair_name": "keypairname",
"name": "launch-configuration-name",
"server_type_id": "s1v1m2",
"tags": [
{
"key": "key",
"value": "value"
}
],
"user_data": "IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==",
"volumes": [
{
"boot_index": 0,
"size": 104,
"type": "SSD"
}
]
}
Example HTTP response
Response 201
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_count": 1,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"keypair_name": "keypairname",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "launch-configuration-name",
"public_key": "ssh-rsa fakeKey Generated-by-SCP",
"server_type_id": "s1v1m2",
"state": "ACTIVE",
"user_data": "IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==",
"volumes": [
{
"boot_index": 0,
"size": 104,
"type": "SSD"
}
]
}
1.14 - Create Server Group
1.14.1 - 1.2
post /v1/server-groups
Description
Create server group.
State
ACTIVE (CURRENT)
Parameters
Responses
| HTTP Code | Description | Schema |
|---|
| 201 | Created | ServerGroup |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/server-groups
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"name": "server-group",
"policy": "anti-affinity",
"tags": [
{
"key": "key",
"value": "value"
}
]
}
Example HTTP response
Response 201
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"members": [
"2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
],
"name": "server-group",
"partition_size": 3,
"policy": "anti-affinity",
"user_id": "570907805e5447be84b618450ef52o0t"
}
1.14.2 - 1.1
post /v1/server-groups
Description
Create server group.
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
Responses
| HTTP Code | Description | Schema |
|---|
| 201 | Created | ServerGroup |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/server-groups
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"name": "server-group",
"policy": "anti-affinity",
"tags": [
{
"key": "key",
"value": "value"
}
]
}
Example HTTP response
Response 201
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"members": [
"2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
],
"name": "server-group",
"partition_size": 3,
"policy": "anti-affinity",
"user_id": "570907805e5447be84b618450ef52o0t"
}
1.14.3 - 1.0
post /v1/server-groups
Description
Create server group.
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
Responses
| HTTP Code | Description | Schema |
|---|
| 201 | Created | ServerGroup |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/server-groups
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"name": "server-group",
"policy": "anti-affinity",
"tags": [
{
"key": "key",
"value": "value"
}
]
}
Example HTTP response
Response 201
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"members": [
"2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
],
"name": "server-group",
"partition_size": 3,
"policy": "anti-affinity",
"user_id": "570907805e5447be84b618450ef52o0t"
}
1.15 - Create Server Interface
1.15.1 - 1.2
post /v1/servers/{server_id}/interfaces
Description
Create a new network port to the virtual server, or add an existing network port.
When creating a new network port, enter the subnet ID. IP can be set to auto-generate or user input fixed ips.
If you want to add an existing network port, enter the port ID.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
| body | body
required |
| ServerInterfaceCreateRequest | |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | InterfaceResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"fixed_ips": [
{
"ip_address": "192.169.3.2"
}
],
"port_id": "91424c08-0b26-49fb-9808-ed042292ceef",
"subnet_id": "78b2ee3f074145c580ab6abac4821f97"
}
Example HTTP response
Response 200
{
"fixed_ips": [
{
"ip_address": "192.169.3.2"
}
],
"mac_addr": "fa:16:3e:c0:71:2b",
"port_id": "f2b02fc5-a5fd-4b5f-b1a9-987f4c0d66cc",
"port_state": "ACTIVE",
"private_static_nat": {
"external_ip_address": "182.197.61.81",
"id": "224b80106e6f41b38efe98ac9ddbf280",
"private_nat_ip_id": "1f0cb5390c40483592ddc5a282f53496",
"state": "ACTIVE"
},
"static_nat": {
"external_ip_address": "182.197.61.81",
"id": "224b80106e6f41b38efe98ac9ddbf280",
"publicip_id": "615fa9cd5cff486c9de679b3ce63e601",
"state": "ACTIVE"
},
"subnet_id": "183c6c30df0c4fcbb16422aa2d64aa21"
}
1.15.2 - 1.1
post /v1/servers/{server_id}/interfaces
Description
Create a new network port to the virtual server, or add an existing network port.
When creating a new network port, enter the subnet ID. IP can be set to auto-generate or user input fixed ips.
If you want to add an existing network port, enter the port ID.
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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
| body | body
required |
| ServerInterfaceCreateRequest | |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | InterfaceResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"fixed_ips": [
{
"ip_address": "192.169.3.2"
}
],
"port_id": "91424c08-0b26-49fb-9808-ed042292ceef",
"subnet_id": "78b2ee3f074145c580ab6abac4821f97"
}
Example HTTP response
Response 200
{
"fixed_ips": [
{
"ip_address": "192.169.3.2"
}
],
"mac_addr": "fa:16:3e:c0:71:2b",
"port_id": "f2b02fc5-a5fd-4b5f-b1a9-987f4c0d66cc",
"port_state": "ACTIVE",
"private_static_nat": {
"external_ip_address": "182.197.61.81",
"id": "224b80106e6f41b38efe98ac9ddbf280",
"private_nat_ip_id": "1f0cb5390c40483592ddc5a282f53496",
"state": "ACTIVE"
},
"static_nat": {
"external_ip_address": "182.197.61.81",
"id": "224b80106e6f41b38efe98ac9ddbf280",
"publicip_id": "615fa9cd5cff486c9de679b3ce63e601",
"state": "ACTIVE"
},
"subnet_id": "183c6c30df0c4fcbb16422aa2d64aa21"
}
1.15.3 - 1.0
post /v1/servers/{server_id}/interfaces
Description
Create a new network port to the virtual server, or add an existing network port.
When creating a new network port, enter the subnet ID. IP can be set to auto-generate or user input fixed ips.
If you want to add an existing network port, enter the port ID.
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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
| body | body
required |
| ServerInterfaceCreateRequest | |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | InterfaceResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"fixed_ips": [
{
"ip_address": "192.169.3.2"
}
],
"port_id": "91424c08-0b26-49fb-9808-ed042292ceef",
"subnet_id": "78b2ee3f074145c580ab6abac4821f97"
}
Example HTTP response
Response 200
{
"fixed_ips": [
{
"ip_address": "192.169.3.2"
}
],
"mac_addr": "fa:16:3e:c0:71:2b",
"port_id": "f2b02fc5-a5fd-4b5f-b1a9-987f4c0d66cc",
"port_state": "ACTIVE",
"private_static_nat": {
"external_ip_address": "182.197.61.81",
"id": "224b80106e6f41b38efe98ac9ddbf280",
"private_nat_ip_id": "1f0cb5390c40483592ddc5a282f53496",
"state": "ACTIVE"
},
"static_nat": {
"external_ip_address": "182.197.61.81",
"id": "224b80106e6f41b38efe98ac9ddbf280",
"publicip_id": "615fa9cd5cff486c9de679b3ce63e601",
"state": "ACTIVE"
},
"subnet_id": "183c6c30df0c4fcbb16422aa2d64aa21"
}
1.16 - Create Server Interface Nat
1.16.1 - 1.2
post /v1/servers/{server_id}/interfaces/{port_id}/static-nats
Description
Create Server Interface Public Nat.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
| path | port_id
required | Port ID
Example : 91424c08-0b26-49fb-9808-ed042292ceef
| string | None |
| body | body
required |
| ServerStaticNatCreateRequest | |
Responses
| HTTP Code | Description | Schema |
|---|
| 201 | Created | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces/{port_id}/static-nats
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"publicip_id": "615fa9cd5cff486c9de679b3ce63e601"
}
Example HTTP response
Response 201
1.16.2 - 1.1
post /v1/servers/{server_id}/interfaces/{port_id}/static-nats
Description
Create Server Interface Public Nat.
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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
| path | port_id
required | Port ID
Example : 91424c08-0b26-49fb-9808-ed042292ceef
| string | None |
| body | body
required |
| ServerStaticNatCreateRequest | |
Responses
| HTTP Code | Description | Schema |
|---|
| 201 | Created | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces/{port_id}/static-nats
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"publicip_id": "615fa9cd5cff486c9de679b3ce63e601"
}
Example HTTP response
Response 201
1.16.3 - 1.0
post /v1/servers/{server_id}/interfaces/{port_id}/static-nats
Description
Create Server Interface Public Nat.
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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
| path | port_id
required | Port ID
Example : 91424c08-0b26-49fb-9808-ed042292ceef
| string | None |
| body | body
required |
| ServerStaticNatCreateRequest | |
Responses
| HTTP Code | Description | Schema |
|---|
| 201 | Created | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces/{port_id}/static-nats
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"publicip_id": "615fa9cd5cff486c9de679b3ce63e601"
}
Example HTTP response
Response 201
1.17 - Create Server Interface Private Nat
1.17.1 - 1.2
post /v1/servers/{server_id}/interfaces/{port_id}/private-static-nats
Description
Create Server Interface Private Nat.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
| path | port_id
required | Port ID
Example : 91424c08-0b26-49fb-9808-ed042292ceef
| string | None |
| body | body
required |
| ServerPrivateStaticNatCreateRequest | |
Responses
| HTTP Code | Description | Schema |
|---|
| 201 | Created | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces/{port_id}/private-static-nats
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"private_nat_id": "3a6c1dc6b1b24e02a444d672c2798a1c",
"private_nat_ip_id": "1f0cb5390c40483592ddc5a282f53496"
}
Example HTTP response
Response 201
1.17.2 - 1.1
post /v1/servers/{server_id}/interfaces/{port_id}/private-static-nats
Description
Create Server Interface Private Nat.
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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
| path | port_id
required | Port ID
Example : 91424c08-0b26-49fb-9808-ed042292ceef
| string | None |
| body | body
required |
| ServerPrivateStaticNatCreateRequest | |
Responses
| HTTP Code | Description | Schema |
|---|
| 201 | Created | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces/{port_id}/private-static-nats
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"private_nat_id": "3a6c1dc6b1b24e02a444d672c2798a1c",
"private_nat_ip_id": "1f0cb5390c40483592ddc5a282f53496"
}
Example HTTP response
Response 201
1.17.3 - 1.0
post /v1/servers/{server_id}/interfaces/{port_id}/private-static-nats
Description
Create Server Interface Private Nat.
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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
| path | port_id
required | Port ID
Example : 91424c08-0b26-49fb-9808-ed042292ceef
| string | None |
| body | body
required |
| ServerPrivateStaticNatCreateRequest | |
Responses
| HTTP Code | Description | Schema |
|---|
| 201 | Created | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces/{port_id}/private-static-nats
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"private_nat_id": "3a6c1dc6b1b24e02a444d672c2798a1c",
"private_nat_ip_id": "1f0cb5390c40483592ddc5a282f53496"
}
Example HTTP response
Response 201
1.18 - Create Server Volume
1.18.1 - 1.2
post /v1/servers/{server_id}/volumes
Description
Attach volume that are created to server.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
| body | body
required |
| ServerVolumesCreateRequest | |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | ServersVolumeResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/volumes
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"delete_on_termination": false,
"device": "/dev/vda",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
Example HTTP response
Response 200
{
"delete_on_termination": false,
"device": "/dev/vda",
"id": "3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c",
"server_id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
1.18.2 - 1.1
post /v1/servers/{server_id}/volumes
Description
Attach volume that are created to 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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
| body | body
required |
| ServerVolumesCreateRequest | |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | ServersVolumeResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/volumes
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"delete_on_termination": false,
"device": "/dev/vda",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
Example HTTP response
Response 200
{
"delete_on_termination": false,
"device": "/dev/vda",
"id": "3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c",
"server_id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
1.18.3 - 1.0
post /v1/servers/{server_id}/volumes
Description
Attach volume that are created to 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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
| body | body
required |
| ServerVolumesCreateRequest | |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | ServersVolumeResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/volumes
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"delete_on_termination": false,
"device": "/dev/vda",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
Example HTTP response
Response 200
{
"delete_on_termination": false,
"device": "/dev/vda",
"id": "3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c",
"server_id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
1.19 - Create Sharing Image
1.19.1 - 1.2
post /v1/images/{image_id}/share
Description
Create Sharing Image.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | image_id
required | Image ID
Example : 70a599e0-31e7-49b7-b260-868f441e862b
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/images/{image_id}/share
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 202
1.19.2 - 1.1
post /v1/images/{image_id}/share
Description
Create Sharing Image.
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
| Type | Name | Description | Schema | Default |
|---|
| path | image_id
required | Image ID
Example : 70a599e0-31e7-49b7-b260-868f441e862b
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/images/{image_id}/share
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 202
1.19.3 - 1.0
post /v1/images/{image_id}/share
Description
Create Sharing Image.
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
| Type | Name | Description | Schema | Default |
|---|
| path | image_id
required | Image ID
Example : 70a599e0-31e7-49b7-b260-868f441e862b
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/images/{image_id}/share
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 202
1.20 - Create Virtual Server
1.20.1 - 1.2
post /v1/servers
Description
Create Virtual Server.
State
ACTIVE (CURRENT)
Parameters
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | ServerCreateResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"file_storage_ids": [
"96d258ea-dd5d-4cca-bb3a-b6909b7e2065",
"949bd9c7-2098-4284-9685-13268d193117"
],
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"keypair_name": "keypairname",
"lock": false,
"max_count": 2,
"metadata": "",
"name": "servername",
"networks": [
{
"fixed_ip": "192.169.3.2",
"port_id": "91424c08-0b26-49fb-9808-ed042292ceef",
"public_ip_id": "615fa9cd5cff486c9de679b3ce63e601",
"subnet_id": "78b2ee3f074145c580ab6abac4821f97"
}
],
"partition_number": 1,
"product_category": "compute",
"product_offering": "virtual_server",
"security_groups": [
"c09c3f05-03d9-443f-b27a-40e0f973c75f"
],
"server_group_id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"server_type_id": "s1v1m2",
"tags": [
{
"key": "key",
"value": "value"
}
],
"user_data": "IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==",
"volumes": [
{
"boot_index": 0,
"delete_on_termination": false,
"max_iops": 10000,
"max_throughput": 500,
"size": 104,
"source_type": "image",
"type": "SSD"
}
]
}
Example HTTP response
Response 202
{
"servers": [
{
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
}
]
}
1.20.2 - 1.1
post /v1/servers
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
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | ServerCreateResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"keypair_name": "keypairname",
"lock": false,
"max_count": 2,
"metadata": "",
"name": "servername",
"networks": [
{
"fixed_ip": "192.169.3.2",
"port_id": "91424c08-0b26-49fb-9808-ed042292ceef",
"public_ip_id": "615fa9cd5cff486c9de679b3ce63e601",
"subnet_id": "78b2ee3f074145c580ab6abac4821f97"
}
],
"partition_number": 1,
"product_category": "compute",
"product_offering": "virtual_server",
"security_groups": [
"c09c3f05-03d9-443f-b27a-40e0f973c75f"
],
"server_group_id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"server_type_id": "s1v1m2",
"tags": [
{
"key": "key",
"value": "value"
}
],
"user_data": "IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==",
"volumes": []
}
Example HTTP response
Response 202
{
"servers": [
{
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
}
]
}
1.20.3 - 1.0
post /v1/servers
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
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | ServerCreateResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"keypair_name": "keypairname",
"lock": false,
"max_count": 2,
"metadata": "",
"name": "servername",
"networks": [
{
"fixed_ip": "192.169.3.2",
"port_id": "91424c08-0b26-49fb-9808-ed042292ceef",
"public_ip_id": "615fa9cd5cff486c9de679b3ce63e601",
"subnet_id": "78b2ee3f074145c580ab6abac4821f97"
}
],
"partition_number": 1,
"product_category": "compute",
"product_offering": "virtual_server",
"security_groups": [
"c09c3f05-03d9-443f-b27a-40e0f973c75f"
],
"server_group_id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"server_type_id": "s1v1m2",
"tags": [
{
"key": "key",
"value": "value"
}
],
"user_data": "IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==",
"volumes": []
}
Example HTTP response
Response 202
{
"servers": [
{
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
}
]
}
1.21 - Create Virtual Server Custom Image
1.21.1 - 1.2
post /v1/servers/{server_id}/images
Description
Create Virtual Server Custom Image.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
| body | body
required |
| ServerCreateImageRequestBody | |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | ServerCreateImageResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/images
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"image_name": "imagename"
}
Example HTTP response
Response 202
{
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b"
}
1.21.2 - 1.1
post /v1/servers/{server_id}/images
Description
Create Virtual Server Custom Image.
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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
| body | body
required |
| ServerCreateImageRequestBody | |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | ServerCreateImageResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/images
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"image_name": "imagename"
}
Example HTTP response
Response 202
{
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b"
}
1.21.3 - 1.0
post /v1/servers/{server_id}/images
Description
Create Virtual Server Custom Image.
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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
| body | body
required |
| ServerCreateImageRequestBody | |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | ServerCreateImageResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/images
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"image_name": "imagename"
}
Example HTTP response
Response 202
{
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b"
}
1.22 - Create Virtual Server Dump
1.22.1 - 1.2
post /v1/servers/{server_id}/dump
Description
Create Virtual Server Dump.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/dump
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 202
1.22.2 - 1.1
post /v1/servers/{server_id}/dump
Description
Create Virtual Server Dump.
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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/dump
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 202
1.22.3 - 1.0
post /v1/servers/{server_id}/dump
Description
Create Virtual Server Dump.
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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/dump
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 202
1.23 - Create Volume
1.23.1 - 1.2
post /v1/volumes
Description
Create a Volume.
State
ACTIVE (CURRENT)
Parameters
Responses
Example HTTP request
Request path
/v1/volumes
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"max_iops": 10000,
"max_throughput": 500,
"name": "volume01",
"size": 104,
"snapshot_id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"tags": [
{
"key": "key",
"value": "value"
}
],
"volume_type": "SSD"
}
Example HTTP response
Response 202
{
"bootable": false,
"created_at": "2026-04-14T15:06:27.997Z",
"encrypted": true,
"id": "3f500f00-ed80-4566-a057-e31760226f9a",
"max_iops": 10000,
"max_throughput": 500,
"modified_at": "2025-07-26T12:00:00Z",
"multiattach": false,
"name": "volume01",
"servers": [
{
"attached_at": "2026-04-14T15:06:27.997Z",
"device": "/dev/vda",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
}
],
"size": 104,
"snapshot_id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"state": "available",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_image_metadata": {
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"disk_format": "qcow2",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"min_disk": 100,
"min_ram": 0,
"os_distro": "alma",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"signature_verified": false,
"size": 2429747200
},
"volume_type": "SSD",
"volume_type_id": "c643ac35-3aec-43e6-b97a-3d6f666c5207"
}
1.23.2 - 1.1
post /v1/volumes
Description
Create a Volume.
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
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | VolumeShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/volumes
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"name": "volume01",
"size": 104,
"snapshot_id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"tags": [
{
"key": "key",
"value": "value"
}
],
"volume_type": "SSD"
}
Example HTTP response
Response 202
{
"bootable": false,
"created_at": "2026-04-14T15:06:25.499Z",
"encrypted": true,
"id": "3f500f00-ed80-4566-a057-e31760226f9a",
"modified_at": "2025-07-26T12:00:00Z",
"multiattach": false,
"name": "volume01",
"servers": [
{
"attached_at": "2026-04-14T15:06:25.499Z",
"device": "/dev/vda",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
}
],
"size": 104,
"snapshot_id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"state": "available",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_image_metadata": {
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"disk_format": "qcow2",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"min_disk": 100,
"min_ram": 0,
"os_distro": "alma",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"signature_verified": false,
"size": 2429747200
},
"volume_type": "SSD",
"volume_type_id": "c643ac35-3aec-43e6-b97a-3d6f666c5207"
}
1.23.3 - 1.0
post /v1/volumes
Description
Create a Volume.
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
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | VolumeShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/volumes
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"name": "volume01",
"size": 104,
"snapshot_id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"tags": [
{
"key": "key",
"value": "value"
}
],
"volume_type": "SSD"
}
Example HTTP response
Response 202
{
"bootable": false,
"created_at": "2026-04-14T15:06:23.000Z",
"encrypted": true,
"id": "3f500f00-ed80-4566-a057-e31760226f9a",
"modified_at": "2025-07-26T12:00:00Z",
"multiattach": false,
"name": "volume01",
"servers": [
{
"attached_at": "2026-04-14T15:06:23.000Z",
"device": "/dev/vda",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
}
],
"size": 104,
"snapshot_id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"state": "available",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_image_metadata": {
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"disk_format": "qcow2",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"min_disk": 100,
"min_ram": 0,
"os_distro": "alma",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"signature_verified": false,
"size": 2429747200
},
"volume_type": "SSD",
"volume_type_id": "c643ac35-3aec-43e6-b97a-3d6f666c5207"
}
1.24 - Delete a snapshot
1.24.1 - 1.2
delete /v1/snapshots/{snapshot_id}
Description
Delete a snapshot.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | snapshot_id
required | Snapshot ID
Example : cceed636-1f1e-4bb0-b85c-4e5b9e0bf790
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/snapshots/{snapshot_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 202
1.24.2 - 1.1
delete /v1/snapshots/{snapshot_id}
Description
Delete a snapshot.
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
| Type | Name | Description | Schema | Default |
|---|
| path | snapshot_id
required | Snapshot ID
Example : cceed636-1f1e-4bb0-b85c-4e5b9e0bf790
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/snapshots/{snapshot_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 202
1.24.3 - 1.0
delete /v1/snapshots/{snapshot_id}
Description
Delete a snapshot.
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
| Type | Name | Description | Schema | Default |
|---|
| path | snapshot_id
required | Snapshot ID
Example : cceed636-1f1e-4bb0-b85c-4e5b9e0bf790
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/snapshots/{snapshot_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 202
1.25 - Delete a volume transfer
1.25.1 - 1.2
delete /v1/volume-transfer/{transfer_id}
Description
Delete a volume transfer.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | transfer_id
required | Volume Transfer ID
Example : 1ac231be-823b-4a4d-8ff0-aac503a7118a
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/volume-transfer/{transfer_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 202
1.25.2 - 1.1
delete /v1/volume-transfer/{transfer_id}
Description
Delete a volume transfer.
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
| Type | Name | Description | Schema | Default |
|---|
| path | transfer_id
required | Volume Transfer ID
Example : 1ac231be-823b-4a4d-8ff0-aac503a7118a
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/volume-transfer/{transfer_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 202
1.25.3 - 1.0
delete /v1/volume-transfer/{transfer_id}
Description
Delete a volume transfer.
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
| Type | Name | Description | Schema | Default |
|---|
| path | transfer_id
required | Volume Transfer ID
Example : 1ac231be-823b-4a4d-8ff0-aac503a7118a
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/volume-transfer/{transfer_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 202
1.26 - Delete Auto-Scaling Group
1.26.1 - 1.2
delete /v1/auto-scaling-groups/{auto_scaling_group_id}
Description
Delete Auto-Scaling Group.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 204
1.26.2 - 1.1
delete /v1/auto-scaling-groups/{auto_scaling_group_id}
Description
Delete Auto-Scaling Group.
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
| Type | Name | Description | Schema | Default |
|---|
| path | auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 204
1.26.3 - 1.0
delete /v1/auto-scaling-groups/{auto_scaling_group_id}
Description
Delete Auto-Scaling Group.
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
| Type | Name | Description | Schema | Default |
|---|
| path | auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 204
1.27 - Delete Auto-Scaling Group Notification
1.27.1 - 1.2
delete /v1/auto-scaling-groups/{auto_scaling_group_id}/notifications/{notification_id}
Description
Delete Auto-Scaling Group notification.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | None |
| path | notification_id
required | Auto-Scaling Group notification ID
Example : fa7fd191410744cd810a290c0b4d22b9
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/notifications/{notification_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 204
1.27.2 - 1.1
delete /v1/auto-scaling-groups/{auto_scaling_group_id}/notifications/{notification_id}
Description
Delete Auto-Scaling Group notification.
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
| Type | Name | Description | Schema | Default |
|---|
| path | auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | None |
| path | notification_id
required | Auto-Scaling Group notification ID
Example : fa7fd191410744cd810a290c0b4d22b9
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/notifications/{notification_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 204
1.27.3 - 1.0
delete /v1/auto-scaling-groups/{auto_scaling_group_id}/notifications/{notification_id}
Description
Delete Auto-Scaling Group notification.
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
| Type | Name | Description | Schema | Default |
|---|
| path | auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | None |
| path | notification_id
required | Auto-Scaling Group notification ID
Example : fa7fd191410744cd810a290c0b4d22b9
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/notifications/{notification_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 204
1.28 - Delete Auto-Scaling Group Policy
1.28.1 - 1.2
delete /v1/auto-scaling-groups/{auto_scaling_group_id}/policies/{policy_id}
Description
Delete Auto-Scaling Group policy.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | None |
| path | policy_id
required | Policy ID
Example : 0761d76085f54363bab07909baf69841
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/policies/{policy_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 204
1.28.2 - 1.1
delete /v1/auto-scaling-groups/{auto_scaling_group_id}/policies/{policy_id}
Description
Delete Auto-Scaling Group policy.
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
| Type | Name | Description | Schema | Default |
|---|
| path | auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | None |
| path | policy_id
required | Policy ID
Example : 0761d76085f54363bab07909baf69841
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/policies/{policy_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 204
1.28.3 - 1.0
delete /v1/auto-scaling-groups/{auto_scaling_group_id}/policies/{policy_id}
Description
Delete Auto-Scaling Group policy.
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
| Type | Name | Description | Schema | Default |
|---|
| path | auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | None |
| path | policy_id
required | Policy ID
Example : 0761d76085f54363bab07909baf69841
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/policies/{policy_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 204
1.29 - Delete Auto-Scaling Group Schedule
1.29.1 - 1.2
delete /v1/auto-scaling-groups/{auto_scaling_group_id}/schedules/{schedule_id}
Description
Delete Auto-Scaling Group schedule.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | None |
| path | schedule_id
required | Schedule ID
Example : 43d4841abd404220af5f0904037aba71
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/schedules/{schedule_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 204
1.29.2 - 1.1
delete /v1/auto-scaling-groups/{auto_scaling_group_id}/schedules/{schedule_id}
Description
Delete Auto-Scaling Group schedule.
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
| Type | Name | Description | Schema | Default |
|---|
| path | auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | None |
| path | schedule_id
required | Schedule ID
Example : 43d4841abd404220af5f0904037aba71
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/schedules/{schedule_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 204
1.29.3 - 1.0
delete /v1/auto-scaling-groups/{auto_scaling_group_id}/schedules/{schedule_id}
Description
Delete Auto-Scaling Group schedule.
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
| Type | Name | Description | Schema | Default |
|---|
| path | auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | None |
| path | schedule_id
required | Schedule ID
Example : 43d4841abd404220af5f0904037aba71
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/schedules/{schedule_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 204
1.30 - Delete Image
1.30.1 - 1.2
delete /v1/images/{image_id}
Description
Delete Image.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | image_id
required | Image ID
Example : 70a599e0-31e7-49b7-b260-868f441e862b
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/images/{image_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 204
1.30.2 - 1.1
delete /v1/images/{image_id}
Description
Delete Image.
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
| Type | Name | Description | Schema | Default |
|---|
| path | image_id
required | Image ID
Example : 70a599e0-31e7-49b7-b260-868f441e862b
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/images/{image_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 204
1.30.3 - 1.0
delete /v1/images/{image_id}
Description
Delete Image.
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
| Type | Name | Description | Schema | Default |
|---|
| path | image_id
required | Image ID
Example : 70a599e0-31e7-49b7-b260-868f441e862b
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/images/{image_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 204
1.31 - Delete Image member
1.31.1 - 1.2
delete /v1/images/{image_id}/members/{member_id}
Description
Delete Image member.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | image_id
required | Image ID
Example : 70a599e0-31e7-49b7-b260-868f441e862b
| string | None |
| path | member_id
required | Shared Image member ID
Example : a8f10467abfc4b87b64614ab36eb9ae4
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/images/{image_id}/members/{member_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 204
1.31.2 - 1.1
delete /v1/images/{image_id}/members/{member_id}
Description
Delete Image member.
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
| Type | Name | Description | Schema | Default |
|---|
| path | image_id
required | Image ID
Example : 70a599e0-31e7-49b7-b260-868f441e862b
| string | None |
| path | member_id
required | Shared Image member ID
Example : a8f10467abfc4b87b64614ab36eb9ae4
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/images/{image_id}/members/{member_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 204
1.31.3 - 1.0
delete /v1/images/{image_id}/members/{member_id}
Description
Delete Image member.
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
| Type | Name | Description | Schema | Default |
|---|
| path | image_id
required | Image ID
Example : 70a599e0-31e7-49b7-b260-868f441e862b
| string | None |
| path | member_id
required | Shared Image member ID
Example : a8f10467abfc4b87b64614ab36eb9ae4
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/images/{image_id}/members/{member_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 204
1.32 - Delete Keypair
1.32.1 - 1.2
delete /v1/keypairs/{keypair_name}
Description
Delete keypair.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | keypair_name
required | Keypair name
Example : keypairname
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/keypairs/{keypair_name}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 204
1.32.2 - 1.1
delete /v1/keypairs/{keypair_name}
Description
Delete keypair.
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
| Type | Name | Description | Schema | Default |
|---|
| path | keypair_name
required | Keypair name
Example : keypairname
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/keypairs/{keypair_name}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 204
1.32.3 - 1.0
delete /v1/keypairs/{keypair_name}
Description
Delete keypair.
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
| Type | Name | Description | Schema | Default |
|---|
| path | keypair_name
required | Keypair name
Example : keypairname
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/keypairs/{keypair_name}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 204
1.33 - Delete Launch Configuration
1.33.1 - 1.2
delete /v1/launch-configurations/{launch_configuration_id}
Description
Delete Launch Configuration.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | launch_configuration_id
required | Launch Configuration ID
Example : b5aea5a675fc4f6b9e0fcd1288354c5f
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/launch-configurations/{launch_configuration_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 204
1.33.2 - 1.1
delete /v1/launch-configurations/{launch_configuration_id}
Description
Delete Launch Configuration.
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
| Type | Name | Description | Schema | Default |
|---|
| path | launch_configuration_id
required | Launch Configuration ID
Example : b5aea5a675fc4f6b9e0fcd1288354c5f
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/launch-configurations/{launch_configuration_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 204
1.33.3 - 1.0
delete /v1/launch-configurations/{launch_configuration_id}
Description
Delete Launch Configuration.
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
| Type | Name | Description | Schema | Default |
|---|
| path | launch_configuration_id
required | Launch Configuration ID
Example : b5aea5a675fc4f6b9e0fcd1288354c5f
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/launch-configurations/{launch_configuration_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 204
1.34 - Delete Server Group
1.34.1 - 1.2
delete /v1/server-groups/{server_group_id}
Description
Delete server group
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | server_group_id
required | Server Group ID
Example : 616fb98f-46ca-475e-917e-2563e5a8cd19
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/server-groups/{server_group_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
1.34.2 - 1.1
delete /v1/server-groups/{server_group_id}
Description
Delete server group
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
| Type | Name | Description | Schema | Default |
|---|
| path | server_group_id
required | Server Group ID
Example : 616fb98f-46ca-475e-917e-2563e5a8cd19
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/server-groups/{server_group_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
1.34.3 - 1.0
delete /v1/server-groups/{server_group_id}
Description
Delete server group
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
| Type | Name | Description | Schema | Default |
|---|
| path | server_group_id
required | Server Group ID
Example : 616fb98f-46ca-475e-917e-2563e5a8cd19
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/server-groups/{server_group_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
1.35 - Delete Server Interface
1.35.1 - 1.2
delete /v1/servers/{server_id}/interfaces/{port_id}
Description
Delete Server Interface.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
| path | port_id
required | Port ID
Example : 91424c08-0b26-49fb-9808-ed042292ceef
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces/{port_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
1.35.2 - 1.1
delete /v1/servers/{server_id}/interfaces/{port_id}
Description
Delete Server Interface.
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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
| path | port_id
required | Port ID
Example : 91424c08-0b26-49fb-9808-ed042292ceef
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces/{port_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
1.35.3 - 1.0
delete /v1/servers/{server_id}/interfaces/{port_id}
Description
Delete Server Interface.
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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
| path | port_id
required | Port ID
Example : 91424c08-0b26-49fb-9808-ed042292ceef
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces/{port_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
1.36 - Delete Server Interface Nat
1.36.1 - 1.2
delete /v1/servers/{server_id}/interfaces/{port_id}/static-nats/{nat_id}
Description
Delete Server Interface Public Nat.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
| path | port_id
required | Port ID
Example : 91424c08-0b26-49fb-9808-ed042292ceef
| string | None |
| path | nat_id
required | NAT ID
Example : 224b80106e6f41b38efe98ac9ddbf280
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces/{port_id}/static-nats/{nat_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 202
1.36.2 - 1.1
delete /v1/servers/{server_id}/interfaces/{port_id}/static-nats/{nat_id}
Description
Delete Server Interface Public Nat.
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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
| path | port_id
required | Port ID
Example : 91424c08-0b26-49fb-9808-ed042292ceef
| string | None |
| path | nat_id
required | NAT ID
Example : 224b80106e6f41b38efe98ac9ddbf280
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces/{port_id}/static-nats/{nat_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 202
1.36.3 - 1.0
delete /v1/servers/{server_id}/interfaces/{port_id}/static-nats/{nat_id}
Description
Delete Server Interface Public Nat.
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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
| path | port_id
required | Port ID
Example : 91424c08-0b26-49fb-9808-ed042292ceef
| string | None |
| path | nat_id
required | NAT ID
Example : 224b80106e6f41b38efe98ac9ddbf280
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces/{port_id}/static-nats/{nat_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 202
1.37 - Delete Server Interface Private Nat
1.37.1 - 1.2
delete /v1/servers/{server_id}/interfaces/{port_id}/private-static-nats/{nat_id}
Description
Delete Server Interface Private Nat.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
| path | port_id
required | Port ID
Example : 91424c08-0b26-49fb-9808-ed042292ceef
| string | None |
| path | nat_id
required | NAT ID
Example : 224b80106e6f41b38efe98ac9ddbf280
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces/{port_id}/private-static-nats/{nat_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 202
1.37.2 - 1.1
delete /v1/servers/{server_id}/interfaces/{port_id}/private-static-nats/{nat_id}
Description
Delete Server Interface Private Nat.
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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
| path | port_id
required | Port ID
Example : 91424c08-0b26-49fb-9808-ed042292ceef
| string | None |
| path | nat_id
required | NAT ID
Example : 224b80106e6f41b38efe98ac9ddbf280
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces/{port_id}/private-static-nats/{nat_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 202
1.37.3 - 1.0
delete /v1/servers/{server_id}/interfaces/{port_id}/private-static-nats/{nat_id}
Description
Delete Server Interface Private Nat.
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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
| path | port_id
required | Port ID
Example : 91424c08-0b26-49fb-9808-ed042292ceef
| string | None |
| path | nat_id
required | NAT ID
Example : 224b80106e6f41b38efe98ac9ddbf280
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces/{port_id}/private-static-nats/{nat_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 202
1.38 - Delete Server Volume
1.38.1 - 1.2
delete /v1/servers/{server_id}/volumes/{volume_id}
Description
Delete Server Volume.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
| path | volume_id
required | Volume ID
Example : 3f500f00-ed80-4566-a057-e31760226f9a
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/volumes/{volume_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 202
1.38.2 - 1.1
delete /v1/servers/{server_id}/volumes/{volume_id}
Description
Delete Server Volume.
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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
| path | volume_id
required | Volume ID
Example : 3f500f00-ed80-4566-a057-e31760226f9a
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/volumes/{volume_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 202
1.38.3 - 1.0
delete /v1/servers/{server_id}/volumes/{volume_id}
Description
Delete Server Volume.
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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
| path | volume_id
required | Volume ID
Example : 3f500f00-ed80-4566-a057-e31760226f9a
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/volumes/{volume_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 202
1.39 - Delete Virtual Server
1.39.1 - 1.2
delete /v1/servers/{server_id}
Description
Delete Virtual Server.
Once deleted, the server cannot be recovered and will not be retrieved from the server list.
The termination of the connected storage depends on the delete on termination setting, so if necessary, from Block Storage terminate it.
In case of deletion failure.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 202
1.39.2 - 1.1
delete /v1/servers/{server_id}
Description
Delete Virtual Server.
Once deleted, the server cannot be recovered and will not be retrieved from the server list.
The termination of the connected storage depends on the delete on termination setting, so if necessary, from Block Storage terminate it.
In case of deletion failure.
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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 202
1.39.3 - 1.0
delete /v1/servers/{server_id}
Description
Delete Virtual Server.
Once deleted, the server cannot be recovered and will not be retrieved from the server list.
The termination of the connected storage depends on the delete on termination setting, so if necessary, from Block Storage terminate it.
In case of deletion failure.
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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 202
1.40 - Delete Volume
1.40.1 - 1.2
delete /v1/volumes/{volume_id}
Description
Delete Volume.
- The termination of the connected storage depends on the delete on termination setting, so if necessary, from Block Storage terminate it.
If a volume cannot be deleted.
Connected to server
OS Default volume
Connection with custom Image of Virtual Server
If volume is in state other than available, error, error extending, error restoring, or error managing
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume ID
Example : 3f500f00-ed80-4566-a057-e31760226f9a
| string | None |
| query | cascade
optional | Whether to delete snapshots together
Example : True
| any of [boolean, null] | True |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/volumes/{volume_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 202
1.40.2 - 1.1
delete /v1/volumes/{volume_id}
Description
Delete Volume.
- The termination of the connected storage depends on the delete on termination setting, so if necessary, from Block Storage terminate it.
If a volume cannot be deleted.
Connected to server
OS Default volume
Connection with custom Image of Virtual Server
If volume is in state other than available, error, error extending, error restoring, or error managing
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
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume ID
Example : 3f500f00-ed80-4566-a057-e31760226f9a
| string | None |
| query | cascade
optional | Whether to delete snapshots together
Example : True
| any of [boolean, null] | True |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/volumes/{volume_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 202
1.40.3 - 1.0
delete /v1/volumes/{volume_id}
Description
Delete Volume.
- The termination of the connected storage depends on the delete on termination setting, so if necessary, from Block Storage terminate it.
If a volume cannot be deleted.
Connected to server
OS Default volume
Connection with custom Image of Virtual Server
If volume is in state other than available, error, error extending, error restoring, or error managing
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
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume ID
Example : 3f500f00-ed80-4566-a057-e31760226f9a
| string | None |
| query | cascade
optional | Whether to delete snapshots together
Example : True
| any of [boolean, null] | True |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/volumes/{volume_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 202
1.41 - Detach Virtual Server Security Group
1.41.1 - 1.0
delete /v1/servers/{server_id}/security-groups/{security_group_id}
Description
Detach the Security Group from a server.
- If a server has one or more networks attached, and the Security Group you want to detach is currently applied to all of those networks, then the Security Group will be removed from every network associated with a 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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
| path | security_group_id
required | Security Group ID
Example : c09c3f05-03d9-443f-b27a-40e0f973c75f
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/security-groups/{security_group_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 202
1.42 - Detach Volume from Virtual Server
1.42.1 - 1.2
delete /v1/volumes/{volume_id}/servers/{server_id}
Description
Detach the Volume from a server.
For the OS’s default volume, you cannot modify the attached server or cancel the service.
On the server, be sure to perform the disconnection steps (unmount, set the disk offline) before detaching the attached server. If a server is detached without these OS‑level actions, it may enter an error state (Hang).
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume ID
Example : 3f500f00-ed80-4566-a057-e31760226f9a
| string | None |
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/volumes/{volume_id}/servers/{server_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 202
1.42.2 - 1.1
delete /v1/volumes/{volume_id}/servers/{server_id}
Description
Detach the Volume from a server.
For the OS’s default volume, you cannot modify the attached server or cancel the service.
On the server, be sure to perform the disconnection steps (unmount, set the disk offline) before detaching the attached server. If a server is detached without these OS‑level actions, it may enter an error state (Hang).
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
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume ID
Example : 3f500f00-ed80-4566-a057-e31760226f9a
| string | None |
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/volumes/{volume_id}/servers/{server_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 202
1.42.3 - 1.0
delete /v1/volumes/{volume_id}/servers/{server_id}
Description
Detach the Volume from a server.
For the OS’s default volume, you cannot modify the attached server or cancel the service.
On the server, be sure to perform the disconnection steps (unmount, set the disk offline) before detaching the attached server. If a server is detached without these OS‑level actions, it may enter an error state (Hang).
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
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume ID
Example : 3f500f00-ed80-4566-a057-e31760226f9a
| string | None |
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/volumes/{volume_id}/servers/{server_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 202
1.43 - Extend Volume
1.43.1 - 1.2
put /v1/volumes/{volume_id}/size
Description
Increase the volume capacity.
Volume capacity can only be increased, reduction is not supported.
When increasing capacity, recovery is possible only by creating new volume from a previously taken snapshot (i.e., the snapshot can be used solely for the new‑volume creation method).
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume ID
Example : 3f500f00-ed80-4566-a057-e31760226f9a
| string | None |
| body | body
required |
| VolumeExtendRequest | |
Responses
Example HTTP request
Request path
/v1/volumes/{volume_id}/size
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
Example HTTP response
Response 202
{
"bootable": false,
"created_at": "2026-04-14T15:06:28.153Z",
"encrypted": true,
"id": "3f500f00-ed80-4566-a057-e31760226f9a",
"max_iops": 10000,
"max_throughput": 500,
"modified_at": "2025-07-26T12:00:00Z",
"multiattach": false,
"name": "volume01",
"servers": [
{
"attached_at": "2026-04-14T15:06:28.153Z",
"device": "/dev/vda",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
}
],
"size": 104,
"snapshot_id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"state": "available",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_image_metadata": {
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"disk_format": "qcow2",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"min_disk": 100,
"min_ram": 0,
"os_distro": "alma",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"signature_verified": false,
"size": 2429747200
},
"volume_type": "SSD",
"volume_type_id": "c643ac35-3aec-43e6-b97a-3d6f666c5207"
}
1.43.2 - 1.1
put /v1/volumes/{volume_id}/size
Description
Increase the volume capacity.
Volume capacity can only be increased, reduction is not supported.
When increasing capacity, recovery is possible only by creating new volume from a previously taken snapshot (i.e., the snapshot can be used solely for the new‑volume creation method).
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
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume ID
Example : 3f500f00-ed80-4566-a057-e31760226f9a
| string | None |
| body | body
required |
| VolumeExtendRequest | |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | VolumeShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/volumes/{volume_id}/size
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
Example HTTP response
Response 202
{
"bootable": false,
"created_at": "2026-04-14T15:06:25.639Z",
"encrypted": true,
"id": "3f500f00-ed80-4566-a057-e31760226f9a",
"modified_at": "2025-07-26T12:00:00Z",
"multiattach": false,
"name": "volume01",
"servers": [
{
"attached_at": "2026-04-14T15:06:25.639Z",
"device": "/dev/vda",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
}
],
"size": 104,
"snapshot_id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"state": "available",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_image_metadata": {
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"disk_format": "qcow2",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"min_disk": 100,
"min_ram": 0,
"os_distro": "alma",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"signature_verified": false,
"size": 2429747200
},
"volume_type": "SSD",
"volume_type_id": "c643ac35-3aec-43e6-b97a-3d6f666c5207"
}
1.43.3 - 1.0
put /v1/volumes/{volume_id}/size
Description
Increase the volume capacity.
Volume capacity can only be increased, reduction is not supported.
When increasing capacity, recovery is possible only by creating new volume from a previously taken snapshot (i.e., the snapshot can be used solely for the new‑volume creation method).
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
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume ID
Example : 3f500f00-ed80-4566-a057-e31760226f9a
| string | None |
| body | body
required |
| VolumeExtendRequest | |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | VolumeShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/volumes/{volume_id}/size
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
Example HTTP response
Response 202
{
"bootable": false,
"created_at": "2026-04-14T15:06:23.140Z",
"encrypted": true,
"id": "3f500f00-ed80-4566-a057-e31760226f9a",
"modified_at": "2025-07-26T12:00:00Z",
"multiattach": false,
"name": "volume01",
"servers": [
{
"attached_at": "2026-04-14T15:06:23.141Z",
"device": "/dev/vda",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
}
],
"size": 104,
"snapshot_id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"state": "available",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_image_metadata": {
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"disk_format": "qcow2",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"min_disk": 100,
"min_ram": 0,
"os_distro": "alma",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"signature_verified": false,
"size": 2429747200
},
"volume_type": "SSD",
"volume_type_id": "c643ac35-3aec-43e6-b97a-3d6f666c5207"
}
1.44 - Get region's maximum partition size.
1.44.1 - 1.2
get /v1/server-groups/partition-size
Description
Get region’s maximum partition size
State
ACTIVE (CURRENT)
Responses
Example HTTP request
Request path
/v1/server-groups/partition-size
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
1.44.2 - 1.1
get /v1/server-groups/partition-size
Description
Get region’s maximum partition size
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 |
Responses
Example HTTP request
Request path
/v1/server-groups/partition-size
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
1.44.3 - 1.0
get /v1/server-groups/partition-size
Description
Get region’s maximum partition size
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 |
Responses
Example HTTP request
Request path
/v1/server-groups/partition-size
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
1.45 - Import Image
1.45.1 - 1.2
post /v1/images/{image_id}/import
Description
Connect an external image file to use as an image resource.
You need the URL of the image file uploaded to Object Storage.
The Object Storage bucket containing the image must be in the same zone as the server you are creating.
The image file must have a .qcow2 extension.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | image_id
required | Image ID
Example : 70a599e0-31e7-49b7-b260-868f441e862b
| string | None |
| body | body
required |
| ImageImportRequest | |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/images/{image_id}/import
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"url": "https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2"
}
Example HTTP response
Response 202
1.45.2 - 1.1
post /v1/images/{image_id}/import
Description
Connect an external image file to use as an image resource.
You need the URL of the image file uploaded to Object Storage.
The Object Storage bucket containing the image must be in the same zone as the server you are creating.
The image file must have a .qcow2 extension.
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
| Type | Name | Description | Schema | Default |
|---|
| path | image_id
required | Image ID
Example : 70a599e0-31e7-49b7-b260-868f441e862b
| string | None |
| body | body
required |
| ImageImportRequest | |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/images/{image_id}/import
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"url": "https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2"
}
Example HTTP response
Response 202
1.45.3 - 1.0
post /v1/images/{image_id}/import
Description
Connect an external image file to use as an image resource.
You need the URL of the image file uploaded to Object Storage.
The Object Storage bucket containing the image must be in the same zone as the server you are creating.
The image file must have a .qcow2 extension.
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
| Type | Name | Description | Schema | Default |
|---|
| path | image_id
required | Image ID
Example : 70a599e0-31e7-49b7-b260-868f441e862b
| string | None |
| body | body
required |
| ImageImportRequest | |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/images/{image_id}/import
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"url": "https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2"
}
Example HTTP response
Response 202
1.46 - List Auto-Scaling Group LB Server Groups
1.46.1 - 1.2
get /v1/auto-scaling-groups/{auto_scaling_group_id}/lb-server-groups
Description
List Auto-Scaling Group LB Server Groups.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | None |
| query | offset
optional | Index of where to start in the list
Example : 0
| any of [integer, null] | 0 |
| query | limit
optional | Page size of items
Example : 20
| any of [integer, null] | 20 |
| query | sort
optional | Comma-separated list of sort keys and optional sort directions in the form of [:]
Example : created_at:desc
| any of [string, null] | created_at:desc,id:desc |
Responses
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/lb-server-groups
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"count": 20,
"lb_server_groups": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "lb-server-group-name",
"port": 8080
}
]
}
1.46.2 - 1.1
get /v1/auto-scaling-groups/{auto_scaling_group_id}/lb-server-groups
Description
List Auto-Scaling Group LB Server Groups.
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
| Type | Name | Description | Schema | Default |
|---|
| path | auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | None |
| query | offset
optional | Index of where to start in the list
Example : 0
| any of [integer, null] | 0 |
| query | limit
optional | Page size of items
Example : 20
| any of [integer, null] | 20 |
| query | sort
optional | Comma-separated list of sort keys and optional sort directions in the form of [:]
Example : created_at:desc
| any of [string, null] | created_at:desc,id:desc |
Responses
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/lb-server-groups
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"count": 20,
"lb_server_groups": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "lb-server-group-name",
"port": 8080
}
]
}
1.46.3 - 1.0
get /v1/auto-scaling-groups/{auto_scaling_group_id}/lb-server-groups
Description
List Auto-Scaling Group LB Server Groups.
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
| Type | Name | Description | Schema | Default |
|---|
| path | auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | None |
| query | offset
optional | Index of where to start in the list
Example : 0
| any of [integer, null] | 0 |
| query | limit
optional | Page size of items
Example : 20
| any of [integer, null] | 20 |
| query | sort
optional | Comma-separated list of sort keys and optional sort directions in the form of [:]
Example : created_at:desc
| any of [string, null] | created_at:desc,id:desc |
Responses
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/lb-server-groups
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"count": 20,
"lb_server_groups": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "lb-server-group-name",
"port": 8080
}
]
}
1.47 - List Auto-Scaling Group Notifications
1.47.1 - 1.2
get /v1/auto-scaling-groups/{auto_scaling_group_id}/notifications
Description
List Auto-Scaling Group notifications.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | None |
| query | user_ids
optional | User ID list
Example : ['570907805e5447be84b618450ef52o0t']
| any of [array[string], null] | [] |
| query | notification_state
optional | Auto-Scaling Group notification state
Example : ACTIVE
| any of [string, null] | [] |
| query | notification_event
optional | Auto-Scaling Group notification event
Example : SCALE_OUT
| any of [string, null] | [] |
| query | offset
optional | Index of where to start in the list
Example : 0
| any of [integer, null] | 0 |
| query | limit
optional | Page size of items
Example : 20
| any of [integer, null] | 20 |
| query | sort
optional | Comma-separated list of sort keys and optional sort directions in the form of [:]
Example : created_at:desc
| any of [string, null] | created_at:desc |
Responses
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/notifications
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"count": 20,
"notifications": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"notification_events": [
"SCALE_OUT",
"SCALE_OUT_FAIL"
],
"notification_state": "ACTIVE",
"user_email": "scpuser@samsung.com",
"user_id": "570907805e5447be84b618450ef52o0t",
"user_name": "scpuser"
}
]
}
1.47.2 - 1.1
get /v1/auto-scaling-groups/{auto_scaling_group_id}/notifications
Description
List Auto-Scaling Group notifications.
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
| Type | Name | Description | Schema | Default |
|---|
| path | auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | None |
| query | user_ids
optional | User ID list
Example : ['570907805e5447be84b618450ef52o0t']
| any of [array[string], null] | [] |
| query | notification_state
optional | Auto-Scaling Group notification state
Example : ACTIVE
| any of [string, null] | [] |
| query | notification_event
optional | Auto-Scaling Group notification event
Example : SCALE_OUT
| any of [string, null] | [] |
| query | offset
optional | Index of where to start in the list
Example : 0
| any of [integer, null] | 0 |
| query | limit
optional | Page size of items
Example : 20
| any of [integer, null] | 20 |
| query | sort
optional | Comma-separated list of sort keys and optional sort directions in the form of [:]
Example : created_at:desc
| any of [string, null] | created_at:desc |
Responses
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/notifications
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"count": 20,
"notifications": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"notification_events": [
"SCALE_OUT",
"SCALE_OUT_FAIL"
],
"notification_state": "ACTIVE",
"user_email": "scpuser@samsung.com",
"user_id": "570907805e5447be84b618450ef52o0t",
"user_name": "scpuser"
}
]
}
1.47.3 - 1.0
get /v1/auto-scaling-groups/{auto_scaling_group_id}/notifications
Description
List Auto-Scaling Group notifications.
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
| Type | Name | Description | Schema | Default |
|---|
| path | auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | None |
| query | user_ids
optional | User ID list
Example : ['570907805e5447be84b618450ef52o0t']
| any of [array[string], null] | [] |
| query | notification_state
optional | Auto-Scaling Group notification state
Example : ACTIVE
| any of [string, null] | [] |
| query | notification_event
optional | Auto-Scaling Group notification event
Example : SCALE_OUT
| any of [string, null] | [] |
| query | offset
optional | Index of where to start in the list
Example : 0
| any of [integer, null] | 0 |
| query | limit
optional | Page size of items
Example : 20
| any of [integer, null] | 20 |
| query | sort
optional | Comma-separated list of sort keys and optional sort directions in the form of [:]
Example : created_at:desc
| any of [string, null] | created_at:desc |
Responses
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/notifications
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"count": 20,
"notifications": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"notification_events": [
"SCALE_OUT",
"SCALE_OUT_FAIL"
],
"notification_state": "ACTIVE",
"user_email": "scpuser@samsung.com",
"user_id": "570907805e5447be84b618450ef52o0t",
"user_name": "scpuser"
}
]
}
1.48 - List Auto-Scaling Group Policies
1.48.1 - 1.2
get /v1/auto-scaling-groups/{auto_scaling_group_id}/policies
Description
List Auto-Scaling Group policies.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | None |
| query | name
optional | Policy name
Example : policy-name
| any of [string, null] | None |
| query | metric_method
optional | Metric method
Example : AVG
| any of [enum (AVG, MIN, MAX), null] | None |
| query | metric_type
optional | Metric type
Example : CPU
| any of [string, null] | None |
| query | scale_type
optional | Scale type
Example : SCALE_OUT
| any of [enum (SCALE_OUT, SCALE_IN), null] | None |
| query | offset
optional | Index of where to start in the list
Example : 0
| any of [integer, null] | 0 |
| query | limit
optional | Page size of items
Example : 20
| any of [integer, null] | 20 |
| query | sort
optional | Comma-separated list of sort keys and optional sort directions in the form of [:]
Example : created_at:desc
| any of [string, null] | created_at:desc,id:desc |
Responses
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/policies
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"count": 20,
"policies": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"comparison_operator": "ge",
"cooldown_seconds": 300,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"evaluation_minutes": 5,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"metric_method": "AVG",
"metric_type": "CPU",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "policy-name",
"scale_method": "AMOUNT",
"scale_type": "SCALE_OUT",
"scale_value": 10,
"state": "ACTIVE",
"threshold": 60,
"threshold_unit": "%"
}
]
}
1.48.2 - 1.1
get /v1/auto-scaling-groups/{auto_scaling_group_id}/policies
Description
List Auto-Scaling Group policies.
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
| Type | Name | Description | Schema | Default |
|---|
| path | auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | None |
| query | name
optional | Policy name
Example : policy-name
| any of [string, null] | None |
| query | metric_method
optional | Metric method
Example : AVG
| any of [enum (AVG, MIN, MAX), null] | None |
| query | metric_type
optional | Metric type
Example : CPU
| any of [string, null] | None |
| query | scale_type
optional | Scale type
Example : SCALE_OUT
| any of [enum (SCALE_OUT, SCALE_IN), null] | None |
| query | offset
optional | Index of where to start in the list
Example : 0
| any of [integer, null] | 0 |
| query | limit
optional | Page size of items
Example : 20
| any of [integer, null] | 20 |
| query | sort
optional | Comma-separated list of sort keys and optional sort directions in the form of [:]
Example : created_at:desc
| any of [string, null] | created_at:desc,id:desc |
Responses
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/policies
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"count": 20,
"policies": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"comparison_operator": "ge",
"cooldown_seconds": 300,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"evaluation_minutes": 5,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"metric_method": "AVG",
"metric_type": "CPU",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "policy-name",
"scale_method": "AMOUNT",
"scale_type": "SCALE_OUT",
"scale_value": 10,
"state": "ACTIVE",
"threshold": 60,
"threshold_unit": "%"
}
]
}
1.48.3 - 1.0
get /v1/auto-scaling-groups/{auto_scaling_group_id}/policies
Description
List Auto-Scaling Group policies.
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
| Type | Name | Description | Schema | Default |
|---|
| path | auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | None |
| query | name
optional | Policy name
Example : policy-name
| any of [string, null] | None |
| query | metric_method
optional | Metric method
Example : AVG
| any of [enum (AVG, MIN, MAX), null] | None |
| query | metric_type
optional | Metric type
Example : CPU
| any of [string, null] | None |
| query | scale_type
optional | Scale type
Example : SCALE_OUT
| any of [enum (SCALE_OUT, SCALE_IN), null] | None |
| query | offset
optional | Index of where to start in the list
Example : 0
| any of [integer, null] | 0 |
| query | limit
optional | Page size of items
Example : 20
| any of [integer, null] | 20 |
| query | sort
optional | Comma-separated list of sort keys and optional sort directions in the form of [:]
Example : created_at:desc
| any of [string, null] | created_at:desc,id:desc |
Responses
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/policies
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"count": 20,
"policies": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"comparison_operator": "ge",
"cooldown_seconds": 300,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"evaluation_minutes": 5,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"metric_method": "AVG",
"metric_type": "CPU",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "policy-name",
"scale_method": "AMOUNT",
"scale_type": "SCALE_OUT",
"scale_value": 10,
"state": "ACTIVE",
"threshold": 60,
"threshold_unit": "%"
}
]
}
1.49 - List Auto-Scaling Group Schedules
1.49.1 - 1.2
get /v1/auto-scaling-groups/{auto_scaling_group_id}/schedules
Description
Get Auto-Scaling Group schedule list.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | None |
| query | size
optional | size
Example : 20
| any of [integer, null] | 20 |
| query | page
optional | page
Example : 0
| any of [integer, null] | 0 |
| query | sort
optional | sort
Example : created_at:desc
| any of [string, null] | None |
| query | frequency
optional | Frequency
Example : WEEKLY
| any of [enum (ONCE, DAILY, WEEKLY, MONTHLY), null] | None |
Responses
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/schedules
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"schedules": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"day_of_month": "-1,1",
"day_of_week": "SU,SA",
"description": "description",
"desired_server_count": 1,
"end_date": "2025-01-01",
"frequency": "WEEKLY",
"hour": 9,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"max_server_count": 2,
"min_server_count": 1,
"minute": 0,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "schedulename",
"start_date": "2024-01-01",
"state": "ACTIVE",
"timezone": "Asia/Seoul"
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
1.49.2 - 1.1
get /v1/auto-scaling-groups/{auto_scaling_group_id}/schedules
Description
Get Auto-Scaling Group schedule list.
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
| Type | Name | Description | Schema | Default |
|---|
| path | auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | None |
| query | size
optional | size
Example : 20
| any of [integer, null] | 20 |
| query | page
optional | page
Example : 0
| any of [integer, null] | 0 |
| query | sort
optional | sort
Example : created_at:desc
| any of [string, null] | None |
| query | frequency
optional | Frequency
Example : WEEKLY
| any of [enum (ONCE, DAILY, WEEKLY, MONTHLY), null] | None |
Responses
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/schedules
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"schedules": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"day_of_month": "-1,1",
"day_of_week": "SU,SA",
"description": "description",
"desired_server_count": 1,
"end_date": "2025-01-01",
"frequency": "WEEKLY",
"hour": 9,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"max_server_count": 2,
"min_server_count": 1,
"minute": 0,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "schedulename",
"start_date": "2024-01-01",
"state": "ACTIVE",
"timezone": "Asia/Seoul"
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
1.49.3 - 1.0
get /v1/auto-scaling-groups/{auto_scaling_group_id}/schedules
Description
Get Auto-Scaling Group schedule list.
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
| Type | Name | Description | Schema | Default |
|---|
| path | auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | None |
| query | size
optional | size
Example : 20
| any of [integer, null] | 20 |
| query | page
optional | page
Example : 0
| any of [integer, null] | 0 |
| query | sort
optional | sort
Example : created_at:desc
| any of [string, null] | None |
| query | frequency
optional | Frequency
Example : WEEKLY
| any of [enum (ONCE, DAILY, WEEKLY, MONTHLY), null] | None |
Responses
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/schedules
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"schedules": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"day_of_month": "-1,1",
"day_of_week": "SU,SA",
"description": "description",
"desired_server_count": 1,
"end_date": "2025-01-01",
"frequency": "WEEKLY",
"hour": 9,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"max_server_count": 2,
"min_server_count": 1,
"minute": 0,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "schedulename",
"start_date": "2024-01-01",
"state": "ACTIVE",
"timezone": "Asia/Seoul"
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
1.50 - List Auto-Scaling Group Virtual Servers
1.50.1 - 1.2
get /v1/auto-scaling-groups/{auto_scaling_group_id}/virtual-servers
Description
List Auto-Scaling Group Virtual Servers.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | None |
| query | marker
optional | The last item’s ID from previous request
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| any of [string, null] | None |
| query | limit
optional | Page size of items
Example : 20
| any of [integer, null] | 20 |
| query | sort
optional | Comma-separated list of sort keys and optional sort directions in the form of [:]
Example : created_at:desc
| any of [string, null] | created_at:desc |
Responses
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/virtual-servers
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"servers": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"addresses": [
{
"ip_addresses": [
{
"ip_address": "192.169.3.2",
"version": 4
}
],
"subnet_name": "subnetname"
}
],
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2026-04-14T15:06:26.202Z",
"created_by": "97e6b22c9a4143789ca522df7457a32f",
"disk_config": "MANUAL",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"is_asg_virtual_server_healthy": true,
"is_lb_healthy": true,
"is_marketplace": false,
"keypair_name": "keypairname",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"lb_linked_state": "ATTACHED",
"locked": false,
"metadata": "",
"modified_at": "2026-04-14T15:06:26.202Z",
"name": "servername",
"partition_number": 1,
"planned_compute_os_type": "windows",
"product_category": "compute",
"product_offering": "virtual_server",
"security_groups": [
{
"name": "securitygroup"
}
],
"server_group_id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"server_type": {
"disk": 100,
"ephemeral": 0,
"extra_specs": "",
"id": "s1v1m2",
"name": "s1v1m2",
"ram": 2,
"swap": 0,
"vcpus": 1
},
"state": "ACTIVE",
"volumes": [
{
"delete_on_termination": false,
"id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
],
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
]
}
1.50.2 - 1.1
get /v1/auto-scaling-groups/{auto_scaling_group_id}/virtual-servers
Description
List Auto-Scaling Group Virtual Servers.
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
| Type | Name | Description | Schema | Default |
|---|
| path | auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | None |
| query | marker
optional | The last item’s ID from previous request
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| any of [string, null] | None |
| query | limit
optional | Page size of items
Example : 20
| any of [integer, null] | 20 |
| query | sort
optional | Comma-separated list of sort keys and optional sort directions in the form of [:]
Example : created_at:desc
| any of [string, null] | created_at:desc |
Responses
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/virtual-servers
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"servers": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"addresses": [
{
"ip_addresses": [
{
"ip_address": "192.169.3.2",
"version": 4
}
],
"subnet_name": "subnetname"
}
],
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2026-04-14T15:06:23.746Z",
"created_by": "97e6b22c9a4143789ca522df7457a32f",
"disk_config": "MANUAL",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"is_marketplace": false,
"keypair_name": "keypairname",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"lb_linked_state": "ATTACHED",
"locked": false,
"metadata": "",
"modified_at": "2026-04-14T15:06:23.746Z",
"name": "servername",
"partition_number": 1,
"planned_compute_os_type": "windows",
"product_category": "compute",
"product_offering": "virtual_server",
"security_groups": [
{
"name": "securitygroup"
}
],
"server_group_id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"server_type": {
"disk": 100,
"ephemeral": 0,
"extra_specs": "",
"id": "s1v1m2",
"name": "s1v1m2",
"ram": 2,
"swap": 0,
"vcpus": 1
},
"state": "ACTIVE",
"volumes": [
{
"delete_on_termination": false,
"id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
],
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
]
}
1.50.3 - 1.0
get /v1/auto-scaling-groups/{auto_scaling_group_id}/virtual-servers
Description
List Auto-Scaling Group Virtual Servers.
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
| Type | Name | Description | Schema | Default |
|---|
| path | auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | None |
| query | marker
optional | The last item’s ID from previous request
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| any of [string, null] | None |
| query | limit
optional | Page size of items
Example : 20
| any of [integer, null] | 20 |
| query | sort
optional | Comma-separated list of sort keys and optional sort directions in the form of [:]
Example : created_at:desc
| any of [string, null] | created_at:desc |
Responses
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/virtual-servers
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"servers": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"addresses": [
{
"ip_addresses": [
{
"ip_address": "192.169.3.2",
"version": 4
}
],
"subnet_name": "subnetname"
}
],
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2026-04-14T15:06:21.206Z",
"created_by": "97e6b22c9a4143789ca522df7457a32f",
"disk_config": "MANUAL",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"is_marketplace": false,
"keypair_name": "keypairname",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"lb_linked_state": "ATTACHED",
"locked": false,
"metadata": "",
"modified_at": "2026-04-14T15:06:21.206Z",
"name": "servername",
"partition_number": 1,
"planned_compute_os_type": "windows",
"product_category": "compute",
"product_offering": "virtual_server",
"security_groups": [
{
"name": "securitygroup"
}
],
"server_group_id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"server_type": {
"disk": 100,
"ephemeral": 0,
"extra_specs": "",
"id": "s1v1m2",
"name": "s1v1m2",
"ram": 2,
"swap": 0,
"vcpus": 1
},
"state": "ACTIVE",
"volumes": [
{
"delete_on_termination": false,
"id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
],
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
]
}
1.51 - List Auto-Scaling Groups
1.51.1 - 1.2
get /v1/auto-scaling-groups
Description
List Auto-Scaling Groups.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| query | name
optional | Auto-Scaling Group name
Example : auto-scaling-group-name
| any of [string, null] | None |
| query | state
optional | Auto-Scaling Group state
Example : IN_SERVICE
| any of [string, null] | None |
| query | launch_configuration_id
optional | Launch Configuration ID
Example : b5aea5a675fc4f6b9e0fcd1288354c5f
| any of [string, null] | None |
| query | launch_configuration_name
optional | Launch Configuration name
Example : launch-configuration-name
| any of [string, null] | None |
| query | lb_server_group_id
optional | LB Server Group ID
Example : d06e87d3-ca9a-461b-8e88-077a542a7335
| any of [string, null] | None |
| query | security_group_id
optional | Security Group ID
Example : c09c3f05-03d9-443f-b27a-40e0f973c75f
| any of [string, null] | None |
| query | subnet_id
optional | Subnet ID
Example : 78b2ee3f074145c580ab6abac4821f97
| any of [string, null] | None |
| query | vpc_id
optional | VPC ID
Example : cc976b621087484ea5fd527f4b78708b
| any of [string, null] | None |
| query | created_by
optional | Created by
Example : 97e6b22c9a4143789ca522df7457a32f
| any of [string, null] | None |
| query | offset
optional | Index of where to start in the list
Example : 0
| any of [integer, null] | 0 |
| query | limit
optional | Page size of items
Example : 20
| any of [integer, null] | 20 |
| query | sort
optional | Comma-separated list of sort keys and optional sort directions in the form of [:]
Example : created_at:desc
| any of [string, null] | created_at:desc,id:desc |
Responses
Example HTTP request
Request path
/v1/auto-scaling-groups
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"auto_scaling_groups": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"desired_server_count": 1,
"desired_server_count_editable": true,
"drain_enabled": true,
"drain_timeout": 300,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"launch_configuration_name": "launch-configuration-name",
"lb_server_groups": [],
"max_server_count": 2,
"min_server_count": 1,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "auto-scaling-group-name",
"security_group_ids": [
"c09c3f05-03d9-443f-b27a-40e0f973c75f"
],
"server_name_prefix": "server-name-prefix",
"state": "IN_SERVICE",
"state_check_delay_time": 300,
"subnet_ids": [],
"use_lb_state_check": true,
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
],
"count": 20
}
1.51.2 - 1.1
get /v1/auto-scaling-groups
Description
List Auto-Scaling Groups.
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
| Type | Name | Description | Schema | Default |
|---|
| query | name
optional | Auto-Scaling Group name
Example : auto-scaling-group-name
| any of [string, null] | None |
| query | state
optional | Auto-Scaling Group state
Example : IN_SERVICE
| any of [string, null] | None |
| query | launch_configuration_id
optional | Launch Configuration ID
Example : b5aea5a675fc4f6b9e0fcd1288354c5f
| any of [string, null] | None |
| query | launch_configuration_name
optional | Launch Configuration name
Example : launch-configuration-name
| any of [string, null] | None |
| query | lb_server_group_id
optional | LB Server Group ID
Example : d06e87d3-ca9a-461b-8e88-077a542a7335
| any of [string, null] | None |
| query | security_group_id
optional | Security Group ID
Example : c09c3f05-03d9-443f-b27a-40e0f973c75f
| any of [string, null] | None |
| query | subnet_id
optional | Subnet ID
Example : 78b2ee3f074145c580ab6abac4821f97
| any of [string, null] | None |
| query | vpc_id
optional | VPC ID
Example : cc976b621087484ea5fd527f4b78708b
| any of [string, null] | None |
| query | created_by
optional | Created by
Example : 97e6b22c9a4143789ca522df7457a32f
| any of [string, null] | None |
| query | offset
optional | Index of where to start in the list
Example : 0
| any of [integer, null] | 0 |
| query | limit
optional | Page size of items
Example : 20
| any of [integer, null] | 20 |
| query | sort
optional | Comma-separated list of sort keys and optional sort directions in the form of [:]
Example : created_at:desc
| any of [string, null] | created_at:desc,id:desc |
Responses
Example HTTP request
Request path
/v1/auto-scaling-groups
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"auto_scaling_groups": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"desired_server_count": 1,
"desired_server_count_editable": true,
"drain_enabled": true,
"drain_timeout": 300,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"launch_configuration_name": "launch-configuration-name",
"lb_server_groups": [],
"max_server_count": 2,
"min_server_count": 1,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "auto-scaling-group-name",
"security_group_ids": [
"c09c3f05-03d9-443f-b27a-40e0f973c75f"
],
"server_name_prefix": "server-name-prefix",
"state": "IN_SERVICE",
"subnet_ids": [],
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
],
"count": 20
}
1.51.3 - 1.0
get /v1/auto-scaling-groups
Description
List Auto-Scaling Groups.
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
| Type | Name | Description | Schema | Default |
|---|
| query | name
optional | Auto-Scaling Group name
Example : auto-scaling-group-name
| any of [string, null] | None |
| query | state
optional | Auto-Scaling Group state
Example : IN_SERVICE
| any of [string, null] | None |
| query | launch_configuration_id
optional | Launch Configuration ID
Example : b5aea5a675fc4f6b9e0fcd1288354c5f
| any of [string, null] | None |
| query | launch_configuration_name
optional | Launch Configuration name
Example : launch-configuration-name
| any of [string, null] | None |
| query | lb_server_group_id
optional | LB Server Group ID
Example : d06e87d3-ca9a-461b-8e88-077a542a7335
| any of [string, null] | None |
| query | security_group_id
optional | Security Group ID
Example : c09c3f05-03d9-443f-b27a-40e0f973c75f
| any of [string, null] | None |
| query | subnet_id
optional | Subnet ID
Example : 78b2ee3f074145c580ab6abac4821f97
| any of [string, null] | None |
| query | vpc_id
optional | VPC ID
Example : cc976b621087484ea5fd527f4b78708b
| any of [string, null] | None |
| query | created_by
optional | Created by
Example : 97e6b22c9a4143789ca522df7457a32f
| any of [string, null] | None |
| query | offset
optional | Index of where to start in the list
Example : 0
| any of [integer, null] | 0 |
| query | limit
optional | Page size of items
Example : 20
| any of [integer, null] | 20 |
| query | sort
optional | Comma-separated list of sort keys and optional sort directions in the form of [:]
Example : created_at:desc
| any of [string, null] | created_at:desc,id:desc |
Responses
Example HTTP request
Request path
/v1/auto-scaling-groups
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"auto_scaling_groups": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"desired_server_count": 1,
"desired_server_count_editable": true,
"drain_enabled": true,
"drain_timeout": 300,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"launch_configuration_name": "launch-configuration-name",
"lb_server_groups": [],
"max_server_count": 2,
"min_server_count": 1,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "auto-scaling-group-name",
"security_group_ids": [
"c09c3f05-03d9-443f-b27a-40e0f973c75f"
],
"server_name_prefix": "server-name-prefix",
"state": "IN_SERVICE",
"subnet_ids": [],
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
],
"count": 20
}
1.52 - List Default Configs
1.52.1 - 1.2
get /v1/default-configs
Description
Retrieves a list of default configuration values, including resource‑usage limits, thresholds, and related settings.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| query | name
optional | Name
Example : key
| any of [string, null] | None |
| query | category
optional | Category
Example : AUTO_SCALING_GROUP
| any of [string, null] | None |
Responses
Example HTTP request
Request path
/v1/default-configs
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"configs": "('key': 'value'}",
"count": 20
}
1.52.2 - 1.1
get /v1/default-configs
Description
Retrieves a list of default configuration values, including resource‑usage limits, thresholds, and related settings.
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
| Type | Name | Description | Schema | Default |
|---|
| query | name
optional | Name
Example : key
| any of [string, null] | None |
| query | category
optional | Category
Example : AUTO_SCALING_GROUP
| any of [string, null] | None |
Responses
Example HTTP request
Request path
/v1/default-configs
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"configs": "('key': 'value'}",
"count": 20
}
1.52.3 - 1.0
get /v1/default-configs
Description
Retrieves a list of default configuration values, including resource‑usage limits, thresholds, and related settings.
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
| Type | Name | Description | Schema | Default |
|---|
| query | name
optional | Name
Example : key
| any of [string, null] | None |
| query | category
optional | Category
Example : AUTO_SCALING_GROUP
| any of [string, null] | None |
Responses
Example HTTP request
Request path
/v1/default-configs
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"configs": "('key': 'value'}",
"count": 20
}
1.53 - List Image members
1.53.1 - 1.2
get /v1/images/{image_id}/members
Description
Retrieves the list of account members with whom the image owner has shared the image.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | image_id
required | Image ID
Example : 70a599e0-31e7-49b7-b260-868f441e862b
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | ImageMemberListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/images/{image_id}/members
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"members": [
{
"created_at": "2025-07-22T09:00:00Z",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"member_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"status": "pending",
"updated_at": "2025-07-26T12:00:00Z"
}
]
}
1.53.2 - 1.1
get /v1/images/{image_id}/members
Description
Retrieves the list of account members with whom the image owner has shared the image.
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
| Type | Name | Description | Schema | Default |
|---|
| path | image_id
required | Image ID
Example : 70a599e0-31e7-49b7-b260-868f441e862b
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | ImageMemberListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/images/{image_id}/members
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"members": [
{
"created_at": "2025-07-22T09:00:00Z",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"member_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"status": "pending",
"updated_at": "2025-07-26T12:00:00Z"
}
]
}
1.53.3 - 1.0
get /v1/images/{image_id}/members
Description
Retrieves the list of account members with whom the image owner has shared the image.
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
| Type | Name | Description | Schema | Default |
|---|
| path | image_id
required | Image ID
Example : 70a599e0-31e7-49b7-b260-868f441e862b
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | ImageMemberListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/images/{image_id}/members
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"members": [
{
"created_at": "2025-07-22T09:00:00Z",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"member_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"status": "pending",
"updated_at": "2025-07-26T12:00:00Z"
}
]
}
1.54 - List Images
1.54.1 - 1.2
get /v1/images
Description
List Images.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| query | limit
optional | Page size of items
Example : 20
| any of [integer, null] | 20 |
| query | marker
optional | The last item’s ID from previous request
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| any of [string, null] | None |
| query | scp_image_type
optional | Image type
Example : custom
| any of [string, null] | None |
| query | scp_original_image_type
optional | Original Image type
Example : standard
| any of [string, null] | None |
| query | name
optional | Image name
Example : imagename
| any of [string, null] | None |
| query | os_distro
optional | OS distribution of the image to be uploaded
Example : alma
| any of [string, null] | None |
| query | status
optional | Image status
Example : active
| any of [string, null] | None |
| query | visibility
optional | Indicates access permissions for the Image. Private: Can be used only within the Account, Shared: Can be shared between Accounts
Example : private
| any of [enum (public, community, shared, private), null] | None |
| query | sort
optional | Comma-separated list of sort keys and optional sort directions in the form of [:]
Example : created_at:desc
| any of [string, null] | created_at:desc |
Responses
Example HTTP request
Request path
/v1/images
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"images": [
{
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"created_at": "2025-07-22T09:00:00Z",
"disk_format": "qcow2",
"file": "/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file",
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"min_disk": 100,
"min_ram": 0,
"name": "imagename",
"os_distro": "alma",
"os_hash_algo": "sha512",
"os_hash_value": "c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99",
"os_hidden": false,
"owner": "a8f10467abfc4b87b64614ab36eb9ae4",
"owner_account_name": "AccountName",
"owner_user_name": "user@samsung.com",
"protected": false,
"root_device_name": "/dev/vda",
"scp_gpu_driver": "535.183.06",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"scp_os_build_version": "20250101",
"scp_os_version": "8.8",
"size": 2429747200,
"status": "active",
"updated_at": "2025-07-26T12:00:00Z",
"url": "https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2",
"virtual_size": 17179869184,
"visibility": "private",
"volumes": "[{\"tag\": null, \"volume_id\": null, \"encryption_options\": null, \"encryption_secret_uuid\": null, \"encryption_format\": null, \"device_name\": \"/dev/vda\", \"disk_bus\": \"virtio\", \"volume_type\": null, \"encrypted\": null, \"image_id\": null, \"device_type\": \"disk\", \"source_type\": \"snapshot\", \"delete_on_termination\": false, \"volume_size\": 104, \"guest_format\": null, \"boot_index\": 0, \"destination_type\": \"volume\", \"snapshot_id\": \"abde9e38-2ed5-4ecd-b23c-b0120e30690e\", \"no_device\": null}]"
}
]
}
1.54.2 - 1.1
get /v1/images
Description
List Images.
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
| Type | Name | Description | Schema | Default |
|---|
| query | limit
optional | Page size of items
Example : 20
| any of [integer, null] | 20 |
| query | marker
optional | The last item’s ID from previous request
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| any of [string, null] | None |
| query | scp_image_type
optional | Image type
Example : custom
| any of [string, null] | None |
| query | scp_original_image_type
optional | Original Image type
Example : standard
| any of [string, null] | None |
| query | name
optional | Image name
Example : imagename
| any of [string, null] | None |
| query | os_distro
optional | OS distribution of the image to be uploaded
Example : alma
| any of [string, null] | None |
| query | status
optional | Image status
Example : active
| any of [string, null] | None |
| query | visibility
optional | Indicates access permissions for the Image. Private: Can be used only within the Account, Shared: Can be shared between Accounts
Example : private
| any of [enum (public, community, shared, private), null] | None |
| query | sort
optional | Comma-separated list of sort keys and optional sort directions in the form of [:]
Example : created_at:desc
| any of [string, null] | created_at:desc |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | ImageListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/images
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"images": [
{
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"created_at": "2025-07-22T09:00:00Z",
"disk_format": "qcow2",
"file": "/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file",
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"min_disk": 100,
"min_ram": 0,
"name": "imagename",
"os_distro": "alma",
"os_hash_algo": "sha512",
"os_hash_value": "c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99",
"os_hidden": false,
"owner": "a8f10467abfc4b87b64614ab36eb9ae4",
"owner_account_name": "AccountName",
"owner_user_name": "user@samsung.com",
"protected": false,
"root_device_name": "/dev/vda",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"scp_os_build_version": "20250101",
"scp_os_version": "8.8",
"size": 2429747200,
"status": "active",
"updated_at": "2025-07-26T12:00:00Z",
"url": "https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2",
"virtual_size": 17179869184,
"visibility": "private",
"volumes": "[{\"tag\": null, \"volume_id\": null, \"encryption_options\": null, \"encryption_secret_uuid\": null, \"encryption_format\": null, \"device_name\": \"/dev/vda\", \"disk_bus\": \"virtio\", \"volume_type\": null, \"encrypted\": null, \"image_id\": null, \"device_type\": \"disk\", \"source_type\": \"snapshot\", \"delete_on_termination\": false, \"volume_size\": 104, \"guest_format\": null, \"boot_index\": 0, \"destination_type\": \"volume\", \"snapshot_id\": \"abde9e38-2ed5-4ecd-b23c-b0120e30690e\", \"no_device\": null}]"
}
]
}
1.54.3 - 1.0
get /v1/images
Description
List Images.
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
| Type | Name | Description | Schema | Default |
|---|
| query | limit
optional | Page size of items
Example : 20
| any of [integer, null] | 20 |
| query | marker
optional | The last item’s ID from previous request
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| any of [string, null] | None |
| query | scp_image_type
optional | Image type
Example : custom
| any of [string, null] | None |
| query | scp_original_image_type
optional | Original Image type
Example : standard
| any of [string, null] | None |
| query | name
optional | Image name
Example : imagename
| any of [string, null] | None |
| query | os_distro
optional | OS distribution of the image to be uploaded
Example : alma
| any of [string, null] | None |
| query | status
optional | Image status
Example : active
| any of [string, null] | None |
| query | visibility
optional | Indicates access permissions for the Image. Private: Can be used only within the Account, Shared: Can be shared between Accounts
Example : private
| any of [enum (public, community, shared, private), null] | None |
| query | sort
optional | Comma-separated list of sort keys and optional sort directions in the form of [:]
Example : created_at:desc
| any of [string, null] | created_at:desc |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | ImageListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/images
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"images": [
{
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"created_at": "2025-07-22T09:00:00Z",
"disk_format": "qcow2",
"file": "/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file",
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"min_disk": 100,
"min_ram": 0,
"name": "imagename",
"os_distro": "alma",
"os_hash_algo": "sha512",
"os_hash_value": "c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99",
"os_hidden": false,
"owner": "a8f10467abfc4b87b64614ab36eb9ae4",
"owner_account_name": "AccountName",
"owner_user_name": "user@samsung.com",
"protected": false,
"root_device_name": "/dev/vda",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"scp_os_build_version": "20250101",
"scp_os_version": "8.8",
"size": 2429747200,
"status": "active",
"updated_at": "2025-07-26T12:00:00Z",
"url": "https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2",
"virtual_size": 17179869184,
"visibility": "private",
"volumes": "[{\"tag\": null, \"volume_id\": null, \"encryption_options\": null, \"encryption_secret_uuid\": null, \"encryption_format\": null, \"device_name\": \"/dev/vda\", \"disk_bus\": \"virtio\", \"volume_type\": null, \"encrypted\": null, \"image_id\": null, \"device_type\": \"disk\", \"source_type\": \"snapshot\", \"delete_on_termination\": false, \"volume_size\": 104, \"guest_format\": null, \"boot_index\": 0, \"destination_type\": \"volume\", \"snapshot_id\": \"abde9e38-2ed5-4ecd-b23c-b0120e30690e\", \"no_device\": null}]"
}
]
}
1.55 - List Keypairs
1.55.1 - 1.2
get /v1/keypairs
Description
Get keypair list.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| query | limit
optional | Page size of items
Example : 20
| any of [integer, null] | None |
| query | marker
optional | The last item’s ID from previous request
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | KeypairListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/keypairs
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"keypairs": [
{
"fingerprint": "7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd",
"name": "keypairname",
"public_key": "ssh-rsa fakeKey Generated-by-SCP",
"type": "ssh"
}
]
}
1.55.2 - 1.1
get /v1/keypairs
Description
Get keypair list.
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
| Type | Name | Description | Schema | Default |
|---|
| query | limit
optional | Page size of items
Example : 20
| any of [integer, null] | None |
| query | marker
optional | The last item’s ID from previous request
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | KeypairListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/keypairs
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"keypairs": [
{
"fingerprint": "7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd",
"name": "keypairname",
"public_key": "ssh-rsa fakeKey Generated-by-SCP",
"type": "ssh"
}
]
}
1.55.3 - 1.0
get /v1/keypairs
Description
Get keypair list.
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
| Type | Name | Description | Schema | Default |
|---|
| query | limit
optional | Page size of items
Example : 20
| any of [integer, null] | None |
| query | marker
optional | The last item’s ID from previous request
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | KeypairListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/keypairs
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"keypairs": [
{
"fingerprint": "7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd",
"name": "keypairname",
"public_key": "ssh-rsa fakeKey Generated-by-SCP",
"type": "ssh"
}
]
}
1.56 - List Launch Configurations
1.56.1 - 1.2
get /v1/launch-configurations
Description
List Launch Configurations.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| query | name
optional | Launch Configuration name
Example : launch-configuration-name
| any of [string, null] | |
| query | image_id
optional | Image ID
Example : 70a599e0-31e7-49b7-b260-868f441e862b
| any of [string, null] | None |
| query | offset
optional | Index of where to start in the list
Example : 0
| any of [integer, null] | 0 |
| query | limit
optional | Page size of items
Example : 20
| any of [integer, null] | 20 |
| query | sort
optional | Comma-separated list of sort keys and optional sort directions in the form of [:]
Example : created_at:asc
| any of [string, null] | created_at:asc |
Responses
Example HTTP request
Request path
/v1/launch-configurations
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"count": 20,
"launch_configurations": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_count": 1,
"boot_disk_size": 104,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"extra_disk_size": 104,
"file_storage_ids": [
""
],
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"keypair_name": "keypairname",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "launch-configuration-name",
"public_key": "ssh-rsa fakeKey Generated-by-SCP",
"server_type_id": "s1v1m2",
"state": "ACTIVE",
"user_data": "IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==",
"volumes": [
{
"boot_index": 0,
"size": 104,
"type": "SSD"
}
]
}
]
}
1.56.2 - 1.1
get /v1/launch-configurations
Description
List Launch Configurations.
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
| Type | Name | Description | Schema | Default |
|---|
| query | name
optional | Launch Configuration name
Example : launch-configuration-name
| any of [string, null] | |
| query | image_id
optional | Image ID
Example : 70a599e0-31e7-49b7-b260-868f441e862b
| any of [string, null] | None |
| query | offset
optional | Index of where to start in the list
Example : 0
| any of [integer, null] | 0 |
| query | limit
optional | Page size of items
Example : 20
| any of [integer, null] | 20 |
| query | sort
optional | Comma-separated list of sort keys and optional sort directions in the form of [:]
Example : created_at:asc
| any of [string, null] | created_at:asc |
Responses
Example HTTP request
Request path
/v1/launch-configurations
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"count": 20,
"launch_configurations": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_count": 1,
"boot_disk_size": 104,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"extra_disk_size": 104,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"keypair_name": "keypairname",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "launch-configuration-name",
"public_key": "ssh-rsa fakeKey Generated-by-SCP",
"server_type_id": "s1v1m2",
"state": "ACTIVE",
"user_data": "IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==",
"volumes": [
{
"boot_index": 0,
"size": 104,
"type": "SSD"
}
]
}
]
}
1.56.3 - 1.0
get /v1/launch-configurations
Description
List Launch Configurations.
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
| Type | Name | Description | Schema | Default |
|---|
| query | name
optional | Launch Configuration name
Example : launch-configuration-name
| any of [string, null] | |
| query | image_id
optional | Image ID
Example : 70a599e0-31e7-49b7-b260-868f441e862b
| any of [string, null] | None |
| query | offset
optional | Index of where to start in the list
Example : 0
| any of [integer, null] | 0 |
| query | limit
optional | Page size of items
Example : 20
| any of [integer, null] | 20 |
| query | sort
optional | Comma-separated list of sort keys and optional sort directions in the form of [:]
Example : created_at:asc
| any of [string, null] | created_at:asc |
Responses
Example HTTP request
Request path
/v1/launch-configurations
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"count": 20,
"launch_configurations": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_count": 1,
"boot_disk_size": 104,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"extra_disk_size": 104,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"keypair_name": "keypairname",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "launch-configuration-name",
"public_key": "ssh-rsa fakeKey Generated-by-SCP",
"server_type_id": "s1v1m2",
"state": "ACTIVE",
"user_data": "IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==",
"volumes": [
{
"boot_index": 0,
"size": 104,
"type": "SSD"
}
]
}
]
}
1.57 - List pending Images
1.57.1 - 1.2
get /v1/pending-images
Description
Retrieve a list of images pending sharing.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| query | scp_image_type
optional | Image type
Example : custom
| any of [string, null] | None |
| query | scp_original_image_type
optional | Original Image type
Example : standard
| any of [string, null] | None |
Responses
Example HTTP request
Request path
/v1/pending-images
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"images": [
{
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"created_at": "2025-07-22T09:00:00Z",
"disk_format": "qcow2",
"file": "/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file",
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"min_disk": 100,
"min_ram": 0,
"name": "imagename",
"os_distro": "alma",
"os_hash_algo": "sha512",
"os_hash_value": "c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99",
"os_hidden": false,
"owner": "a8f10467abfc4b87b64614ab36eb9ae4",
"owner_account_name": "AccountName",
"owner_user_name": "user@samsung.com",
"protected": false,
"root_device_name": "/dev/vda",
"scp_gpu_driver": "535.183.06",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"scp_os_build_version": "20250101",
"scp_os_version": "8.8",
"size": 2429747200,
"status": "active",
"updated_at": "2025-07-26T12:00:00Z",
"url": "https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2",
"virtual_size": 17179869184,
"visibility": "private",
"volumes": "[{\"tag\": null, \"volume_id\": null, \"encryption_options\": null, \"encryption_secret_uuid\": null, \"encryption_format\": null, \"device_name\": \"/dev/vda\", \"disk_bus\": \"virtio\", \"volume_type\": null, \"encrypted\": null, \"image_id\": null, \"device_type\": \"disk\", \"source_type\": \"snapshot\", \"delete_on_termination\": false, \"volume_size\": 104, \"guest_format\": null, \"boot_index\": 0, \"destination_type\": \"volume\", \"snapshot_id\": \"abde9e38-2ed5-4ecd-b23c-b0120e30690e\", \"no_device\": null}]"
}
]
}
1.57.2 - 1.1
get /v1/pending-images
Description
Retrieve a list of images pending sharing.
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
| Type | Name | Description | Schema | Default |
|---|
| query | scp_image_type
optional | Image type
Example : custom
| any of [string, null] | None |
| query | scp_original_image_type
optional | Original Image type
Example : standard
| any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | ImageListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/pending-images
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"images": [
{
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"created_at": "2025-07-22T09:00:00Z",
"disk_format": "qcow2",
"file": "/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file",
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"min_disk": 100,
"min_ram": 0,
"name": "imagename",
"os_distro": "alma",
"os_hash_algo": "sha512",
"os_hash_value": "c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99",
"os_hidden": false,
"owner": "a8f10467abfc4b87b64614ab36eb9ae4",
"owner_account_name": "AccountName",
"owner_user_name": "user@samsung.com",
"protected": false,
"root_device_name": "/dev/vda",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"scp_os_build_version": "20250101",
"scp_os_version": "8.8",
"size": 2429747200,
"status": "active",
"updated_at": "2025-07-26T12:00:00Z",
"url": "https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2",
"virtual_size": 17179869184,
"visibility": "private",
"volumes": "[{\"tag\": null, \"volume_id\": null, \"encryption_options\": null, \"encryption_secret_uuid\": null, \"encryption_format\": null, \"device_name\": \"/dev/vda\", \"disk_bus\": \"virtio\", \"volume_type\": null, \"encrypted\": null, \"image_id\": null, \"device_type\": \"disk\", \"source_type\": \"snapshot\", \"delete_on_termination\": false, \"volume_size\": 104, \"guest_format\": null, \"boot_index\": 0, \"destination_type\": \"volume\", \"snapshot_id\": \"abde9e38-2ed5-4ecd-b23c-b0120e30690e\", \"no_device\": null}]"
}
]
}
1.57.3 - 1.0
get /v1/pending-images
Description
Retrieve a list of images pending sharing.
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
| Type | Name | Description | Schema | Default |
|---|
| query | scp_image_type
optional | Image type
Example : custom
| any of [string, null] | None |
| query | scp_original_image_type
optional | Original Image type
Example : standard
| any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | ImageListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/pending-images
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"images": [
{
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"created_at": "2025-07-22T09:00:00Z",
"disk_format": "qcow2",
"file": "/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file",
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"min_disk": 100,
"min_ram": 0,
"name": "imagename",
"os_distro": "alma",
"os_hash_algo": "sha512",
"os_hash_value": "c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99",
"os_hidden": false,
"owner": "a8f10467abfc4b87b64614ab36eb9ae4",
"owner_account_name": "AccountName",
"owner_user_name": "user@samsung.com",
"protected": false,
"root_device_name": "/dev/vda",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"scp_os_build_version": "20250101",
"scp_os_version": "8.8",
"size": 2429747200,
"status": "active",
"updated_at": "2025-07-26T12:00:00Z",
"url": "https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2",
"virtual_size": 17179869184,
"visibility": "private",
"volumes": "[{\"tag\": null, \"volume_id\": null, \"encryption_options\": null, \"encryption_secret_uuid\": null, \"encryption_format\": null, \"device_name\": \"/dev/vda\", \"disk_bus\": \"virtio\", \"volume_type\": null, \"encrypted\": null, \"image_id\": null, \"device_type\": \"disk\", \"source_type\": \"snapshot\", \"delete_on_termination\": false, \"volume_size\": 104, \"guest_format\": null, \"boot_index\": 0, \"destination_type\": \"volume\", \"snapshot_id\": \"abde9e38-2ed5-4ecd-b23c-b0120e30690e\", \"no_device\": null}]"
}
]
}
1.58 - List Server Groups
1.58.1 - 1.2
get /v1/server-groups
Description
Get server group list.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| query | limit
optional | Page size of items
Example : 20
| any of [integer, null] | None |
| query | offset
optional | Index of where to start in the list
Example : 0
| any of [integer, null] | None |
Responses
Example HTTP request
Request path
/v1/server-groups
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"server_groups": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"members": [
"2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
],
"name": "server-group",
"partition_size": 3,
"policy": "anti-affinity",
"user_id": "570907805e5447be84b618450ef52o0t"
}
]
}
1.58.2 - 1.1
get /v1/server-groups
Description
Get server group list.
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
| Type | Name | Description | Schema | Default |
|---|
| query | limit
optional | Page size of items
Example : 20
| any of [integer, null] | None |
| query | offset
optional | Index of where to start in the list
Example : 0
| any of [integer, null] | None |
Responses
Example HTTP request
Request path
/v1/server-groups
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"server_groups": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"members": [
"2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
],
"name": "server-group",
"partition_size": 3,
"policy": "anti-affinity",
"user_id": "570907805e5447be84b618450ef52o0t"
}
]
}
1.58.3 - 1.0
get /v1/server-groups
Description
Get server group list.
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
| Type | Name | Description | Schema | Default |
|---|
| query | limit
optional | Page size of items
Example : 20
| any of [integer, null] | None |
| query | offset
optional | Index of where to start in the list
Example : 0
| any of [integer, null] | None |
Responses
Example HTTP request
Request path
/v1/server-groups
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"server_groups": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"members": [
"2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
],
"name": "server-group",
"partition_size": 3,
"policy": "anti-affinity",
"user_id": "570907805e5447be84b618450ef52o0t"
}
]
}
1.59 - List Server Interfaces
1.59.1 - 1.2
get /v1/servers/{server_id}/interfaces
Description
List Server Interfaces.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
Responses
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"interfaces": [
{
"fixed_ips": [
{
"ip_address": "192.169.3.2"
}
],
"is_default": true,
"mac_addr": "fa:16:3e:c0:71:2b",
"port_id": "f2b02fc5-a5fd-4b5f-b1a9-987f4c0d66cc",
"port_state": "ACTIVE",
"private_static_nat": {
"external_ip_address": "182.197.61.81",
"id": "224b80106e6f41b38efe98ac9ddbf280",
"private_nat_ip_id": "1f0cb5390c40483592ddc5a282f53496",
"state": "ACTIVE"
},
"static_nat": {
"external_ip_address": "182.197.61.81",
"id": "224b80106e6f41b38efe98ac9ddbf280",
"publicip_id": "615fa9cd5cff486c9de679b3ce63e601",
"state": "ACTIVE"
},
"subnet_id": "183c6c30df0c4fcbb16422aa2d64aa21"
}
]
}
1.59.2 - 1.1
get /v1/servers/{server_id}/interfaces
Description
List Server Interfaces.
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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
Responses
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"interfaces": [
{
"fixed_ips": [
{
"ip_address": "192.169.3.2"
}
],
"mac_addr": "fa:16:3e:c0:71:2b",
"port_id": "f2b02fc5-a5fd-4b5f-b1a9-987f4c0d66cc",
"port_state": "ACTIVE",
"private_static_nat": {
"external_ip_address": "182.197.61.81",
"id": "224b80106e6f41b38efe98ac9ddbf280",
"private_nat_ip_id": "1f0cb5390c40483592ddc5a282f53496",
"state": "ACTIVE"
},
"static_nat": {
"external_ip_address": "182.197.61.81",
"id": "224b80106e6f41b38efe98ac9ddbf280",
"publicip_id": "615fa9cd5cff486c9de679b3ce63e601",
"state": "ACTIVE"
},
"subnet_id": "183c6c30df0c4fcbb16422aa2d64aa21"
}
]
}
1.59.3 - 1.0
get /v1/servers/{server_id}/interfaces
Description
List Server Interfaces.
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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
Responses
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"interfaces": [
{
"fixed_ips": [
{
"ip_address": "192.169.3.2"
}
],
"mac_addr": "fa:16:3e:c0:71:2b",
"port_id": "f2b02fc5-a5fd-4b5f-b1a9-987f4c0d66cc",
"port_state": "ACTIVE",
"private_static_nat": {
"external_ip_address": "182.197.61.81",
"id": "224b80106e6f41b38efe98ac9ddbf280",
"private_nat_ip_id": "1f0cb5390c40483592ddc5a282f53496",
"state": "ACTIVE"
},
"static_nat": {
"external_ip_address": "182.197.61.81",
"id": "224b80106e6f41b38efe98ac9ddbf280",
"publicip_id": "615fa9cd5cff486c9de679b3ce63e601",
"state": "ACTIVE"
},
"subnet_id": "183c6c30df0c4fcbb16422aa2d64aa21"
}
]
}
1.60 - List Server Ips
1.60.1 - 1.2
get /v1/servers/{server_id}/ips
Description
List Server Ips.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
Responses
Example HTTP request
Request path
/v1/servers/{server_id}/ips
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"addresses": [
{
"ip_addresses": [
{
"ip_address": "192.169.3.2",
"version": 4
}
],
"subnet_name": "subnetname"
}
]
}
1.60.2 - 1.1
get /v1/servers/{server_id}/ips
Description
List Server Ips.
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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
Responses
Example HTTP request
Request path
/v1/servers/{server_id}/ips
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"addresses": [
{
"ip_addresses": [
{
"ip_address": "192.169.3.2",
"version": 4
}
],
"subnet_name": "subnetname"
}
]
}
1.60.3 - 1.0
get /v1/servers/{server_id}/ips
Description
List Server Ips.
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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
Responses
Example HTTP request
Request path
/v1/servers/{server_id}/ips
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"addresses": [
{
"ip_addresses": [
{
"ip_address": "192.169.3.2",
"version": 4
}
],
"subnet_name": "subnetname"
}
]
}
1.61 - List Server Types
1.61.1 - 1.2
get /v1/server-types
Description
Get server type list.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| query | limit
optional | Page size of items
Example : 20
| integer | None |
| query | marker
optional | The last item’s ID from previous request
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
| query | min_disk
optional | Minimum disk size
Example : 0
| integer | None |
| query | min_ram
optional | Minimum ram size
Example : 2048
| integer | None |
| query | sort
optional | Comma-separated list of sort keys and optional sort directions in the form of [:]
Example : created_at:desc
| string | None |
Responses
Example HTTP request
Request path
/v1/server-types
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"server_types": [
{
"description": "description",
"disk": 100,
"ephemeral": 0,
"extra_specs": "",
"id": "s1v1m2",
"name": "s1v1m2",
"ram": 2,
"swap": 0,
"vcpus": 1
}
]
}
1.61.2 - 1.1
get /v1/server-types
Description
Get server type list.
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
| Type | Name | Description | Schema | Default |
|---|
| query | limit
optional | Page size of items
Example : 20
| integer | None |
| query | marker
optional | The last item’s ID from previous request
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
| query | min_disk
optional | Minimum disk size
Example : 0
| integer | None |
| query | min_ram
optional | Minimum ram size
Example : 2048
| integer | None |
| query | sort
optional | Comma-separated list of sort keys and optional sort directions in the form of [:]
Example : created_at:desc
| string | None |
Responses
Example HTTP request
Request path
/v1/server-types
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"server_types": [
{
"description": "description",
"disk": 100,
"ephemeral": 0,
"extra_specs": "",
"id": "s1v1m2",
"name": "s1v1m2",
"ram": 2,
"swap": 0,
"vcpus": 1
}
]
}
1.61.3 - 1.0
get /v1/server-types
Description
Get server type list.
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
| Type | Name | Description | Schema | Default |
|---|
| query | limit
optional | Page size of items
Example : 20
| integer | None |
| query | marker
optional | The last item’s ID from previous request
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
| query | min_disk
optional | Minimum disk size
Example : 0
| integer | None |
| query | min_ram
optional | Minimum ram size
Example : 2048
| integer | None |
| query | sort
optional | Comma-separated list of sort keys and optional sort directions in the form of [:]
Example : created_at:desc
| string | None |
Responses
Example HTTP request
Request path
/v1/server-types
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"server_types": [
{
"description": "description",
"disk": 100,
"ephemeral": 0,
"extra_specs": "",
"id": "s1v1m2",
"name": "s1v1m2",
"ram": 2,
"swap": 0,
"vcpus": 1
}
]
}
1.62 - List Server Volumes
1.62.1 - 1.2
get /v1/servers/{server_id}/volumes
Description
List Server Volumes.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
Responses
Example HTTP request
Request path
/v1/servers/{server_id}/volumes
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"volumes": [
{
"delete_on_termination": false,
"device": "/dev/vda",
"id": "3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c",
"server_id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
]
}
1.62.2 - 1.1
get /v1/servers/{server_id}/volumes
Description
List Server Volumes.
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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
Responses
Example HTTP request
Request path
/v1/servers/{server_id}/volumes
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"volumes": [
{
"delete_on_termination": false,
"device": "/dev/vda",
"id": "3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c",
"server_id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
]
}
1.62.3 - 1.0
get /v1/servers/{server_id}/volumes
Description
List Server Volumes.
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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
Responses
Example HTTP request
Request path
/v1/servers/{server_id}/volumes
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"volumes": [
{
"delete_on_termination": false,
"device": "/dev/vda",
"id": "3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c",
"server_id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
]
}
1.63 - List snapshots
1.63.1 - 1.2
get /v1/snapshots
Description
List snapshots.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| query | volume_id
optional | Volume ID
Example : 3f500f00-ed80-4566-a057-e31760226f9a
| any of [string, null] | None |
| query | limit
optional | Page size of items
Example : 20
| any of [integer, null] | None |
| query | offset
optional | Index of where to start in the list
Example : 0
| any of [integer, null] | None |
| query | marker
optional | The last item’s ID from previous request
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| any of [string, null] | None |
| query | with_count
optional | Whether to show count
Example : True
| any of [boolean, null] | True |
| query | name
optional | Snapshot name
Example : snapshot-1
| any of [string, null] | None |
| query | sort
optional | Comma-separated list of sort keys and optional sort directions in the form of [:]
Example : created_at:desc
| any of [string, null] | created_at:desc |
Responses
Example HTTP request
Request path
/v1/snapshots
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"count": 100,
"snapshots": [
{
"created_at": "2025-07-22T09:00:00Z",
"description": "description",
"id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"metadata": "Metadata",
"name": "snapshot-1",
"size": 104,
"status": "available",
"updated_at": "2025-07-26T12:00:00Z",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
]
}
1.63.2 - 1.1
get /v1/snapshots
Description
List snapshots.
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
| Type | Name | Description | Schema | Default |
|---|
| query | volume_id
optional | Volume ID
Example : 3f500f00-ed80-4566-a057-e31760226f9a
| any of [string, null] | None |
| query | limit
optional | Page size of items
Example : 20
| any of [integer, null] | None |
| query | offset
optional | Index of where to start in the list
Example : 0
| any of [integer, null] | None |
| query | marker
optional | The last item’s ID from previous request
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| any of [string, null] | None |
| query | with_count
optional | Whether to show count
Example : True
| any of [boolean, null] | True |
| query | name
optional | Snapshot name
Example : snapshot-1
| any of [string, null] | None |
Responses
Example HTTP request
Request path
/v1/snapshots
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"count": 100,
"snapshots": [
{
"created_at": "2025-07-22T09:00:00Z",
"description": "description",
"id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"metadata": "Metadata",
"name": "snapshot-1",
"size": 104,
"status": "available",
"updated_at": "2025-07-26T12:00:00Z",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
]
}
1.63.3 - 1.0
get /v1/snapshots
Description
List snapshots.
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
| Type | Name | Description | Schema | Default |
|---|
| query | volume_id
optional | Volume ID
Example : 3f500f00-ed80-4566-a057-e31760226f9a
| any of [string, null] | None |
| query | limit
optional | Page size of items
Example : 20
| any of [integer, null] | None |
| query | offset
optional | Index of where to start in the list
Example : 0
| any of [integer, null] | None |
| query | marker
optional | The last item’s ID from previous request
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| any of [string, null] | None |
| query | with_count
optional | Whether to show count
Example : True
| any of [boolean, null] | True |
| query | name
optional | Snapshot name
Example : snapshot-1
| any of [string, null] | None |
Responses
Example HTTP request
Request path
/v1/snapshots
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"count": 100,
"snapshots": [
{
"created_at": "2025-07-22T09:00:00Z",
"description": "description",
"id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"metadata": "Metadata",
"name": "snapshot-1",
"size": 104,
"status": "available",
"updated_at": "2025-07-26T12:00:00Z",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
]
}
1.64 - List Virtual Server Security Group
1.64.1 - 1.2
get /v1/servers/{server_id}/security-groups
Description
List Virtual Server Security Group.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
Responses
Example HTTP request
Request path
/v1/servers/{server_id}/security-groups
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"security_groups": [
{
"account_id": "6f70656e737461636b20342065766572",
"description": "Security group description",
"id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"name": "securitygroup",
"rules": [
{
"from_port": 1,
"id": "ca5cb96b-9df6-4af7-9682-4d60a58d38a5",
"ip_protocol": "tcp",
"ip_range": {
"cidr": "0.0.0.0/0"
},
"to_port": 65535
}
]
}
]
}
1.64.2 - 1.1
get /v1/servers/{server_id}/security-groups
Description
List Virtual Server Security Group.
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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
Responses
Example HTTP request
Request path
/v1/servers/{server_id}/security-groups
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"security_groups": [
{
"account_id": "6f70656e737461636b20342065766572",
"description": "Security group description",
"id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"name": "securitygroup",
"rules": [
{
"from_port": 1,
"id": "ca5cb96b-9df6-4af7-9682-4d60a58d38a5",
"ip_protocol": "tcp",
"ip_range": {
"cidr": "0.0.0.0/0"
},
"to_port": 65535
}
]
}
]
}
1.64.3 - 1.0
get /v1/servers/{server_id}/security-groups
Description
List Virtual Server Security Group.
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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
Responses
Example HTTP request
Request path
/v1/servers/{server_id}/security-groups
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"security_groups": [
{
"account_id": "6f70656e737461636b20342065766572",
"description": "Security group description",
"id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"name": "securitygroup",
"rules": [
{
"from_port": 1,
"id": "ca5cb96b-9df6-4af7-9682-4d60a58d38a5",
"ip_protocol": "tcp",
"ip_range": {
"cidr": "0.0.0.0/0"
},
"to_port": 65535
}
]
}
]
}
1.65 - List Virtual Servers
1.65.1 - 1.2
get /v1/servers
Description
List Virtual Servers.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| query | name
optional | Server name
Example : servername
| any of [string, null] | None |
| query | ip
optional | IP address
Example : 192.169.3.2
| any of [string, null] | None |
| query | state
optional | Server state
Example : ACTIVE
| any of [string, null] | None |
| query | product_category
optional | Product category
Example : compute
| any of [enum (compute, container), null] | None |
| query | product_offering
optional | Product offering
Example : virtual_server
| any of [array[enum (virtual_server, gpu_server, k8s_vm, k8s_gpu_vm)], enum (virtual_server, gpu_server, k8s_vm, k8s_gpu_vm), null] | None |
| query | vpc_id
optional | VPC ID
Example : cc976b621087484ea5fd527f4b78708b
| any of [string, null] | None |
| query | server_type_id
optional | Server type ID
Example : s1v1m2
| any of [string, null] | None |
| query | limit
optional | Page size of items
Example : 20
| any of [integer, null] | None |
| query | marker
optional | The last item’s ID from previous request
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| any of [string, null] | None |
| query | sort
optional | Comma-separated list of sort keys and optional sort directions in the form of [:]
Example : created_at:desc
| any of [string, null] | created_at:desc |
| query | auto_scaling_group_id
optional | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | ServerListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/servers
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"servers": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"addresses": [
{
"ip_addresses": [
{
"ip_address": "192.169.3.2",
"version": 4
}
],
"subnet_name": "subnetname"
}
],
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2026-04-14T15:06:26.871Z",
"created_by": "97e6b22c9a4143789ca522df7457a32f",
"disk_config": "MANUAL",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"is_marketplace": false,
"keypair_name": "keypairname",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"locked": false,
"metadata": "",
"modified_at": "2026-04-14T15:06:26.871Z",
"name": "servername",
"partition_number": 1,
"planned_compute_os_type": "windows",
"product_category": "compute",
"product_offering": "virtual_server",
"security_groups": [
{
"name": "securitygroup"
}
],
"server_group_id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"server_type": {
"disk": 100,
"ephemeral": 0,
"extra_specs": "",
"id": "s1v1m2",
"name": "s1v1m2",
"ram": 2,
"swap": 0,
"vcpus": 1
},
"state": "ACTIVE",
"volumes": [
{
"delete_on_termination": false,
"id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
],
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
]
}
1.65.2 - 1.1
get /v1/servers
Description
List Virtual Servers.
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
| Type | Name | Description | Schema | Default |
|---|
| query | name
optional | Server name
Example : servername
| any of [string, null] | None |
| query | ip
optional | IP address
Example : 192.169.3.2
| any of [string, null] | None |
| query | state
optional | Server state
Example : ACTIVE
| any of [string, null] | None |
| query | product_category
optional | Product category
Example : compute
| any of [enum (compute, container), null] | None |
| query | product_offering
optional | Product offering
Example : virtual_server
| any of [array[enum (virtual_server, gpu_server, k8s_vm, k8s_gpu_vm)], enum (virtual_server, gpu_server, k8s_vm, k8s_gpu_vm), null] | None |
| query | vpc_id
optional | VPC ID
Example : cc976b621087484ea5fd527f4b78708b
| any of [string, null] | None |
| query | server_type_id
optional | Server type ID
Example : s1v1m2
| any of [string, null] | None |
| query | limit
optional | Page size of items
Example : 20
| any of [integer, null] | None |
| query | marker
optional | The last item’s ID from previous request
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| any of [string, null] | None |
| query | sort
optional | Comma-separated list of sort keys and optional sort directions in the form of [:]
Example : created_at:desc
| any of [string, null] | created_at:desc |
| query | auto_scaling_group_id
optional | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | ServerListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/servers
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"servers": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"addresses": [
{
"ip_addresses": [
{
"ip_address": "192.169.3.2",
"version": 4
}
],
"subnet_name": "subnetname"
}
],
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2026-04-14T15:06:24.414Z",
"created_by": "97e6b22c9a4143789ca522df7457a32f",
"disk_config": "MANUAL",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"is_marketplace": false,
"keypair_name": "keypairname",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"locked": false,
"metadata": "",
"modified_at": "2026-04-14T15:06:24.414Z",
"name": "servername",
"partition_number": 1,
"planned_compute_os_type": "windows",
"product_category": "compute",
"product_offering": "virtual_server",
"security_groups": [
{
"name": "securitygroup"
}
],
"server_group_id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"server_type": {
"disk": 100,
"ephemeral": 0,
"extra_specs": "",
"id": "s1v1m2",
"name": "s1v1m2",
"ram": 2,
"swap": 0,
"vcpus": 1
},
"state": "ACTIVE",
"volumes": [
{
"delete_on_termination": false,
"id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
],
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
]
}
1.65.3 - 1.0
get /v1/servers
Description
List Virtual Servers.
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
| Type | Name | Description | Schema | Default |
|---|
| query | name
optional | Server name
Example : servername
| any of [string, null] | None |
| query | ip
optional | IP address
Example : 192.169.3.2
| any of [string, null] | None |
| query | state
optional | Server state
Example : ACTIVE
| any of [string, null] | None |
| query | product_category
optional | Product category
Example : compute
| any of [enum (compute, container), null] | None |
| query | product_offering
optional | Product offering
Example : virtual_server
| any of [array[enum (virtual_server, gpu_server, k8s_vm, k8s_gpu_vm)], enum (virtual_server, gpu_server, k8s_vm, k8s_gpu_vm), null] | None |
| query | vpc_id
optional | VPC ID
Example : cc976b621087484ea5fd527f4b78708b
| any of [string, null] | None |
| query | server_type_id
optional | Server type ID
Example : s1v1m2
| any of [string, null] | None |
| query | limit
optional | Page size of items
Example : 20
| any of [integer, null] | None |
| query | marker
optional | The last item’s ID from previous request
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| any of [string, null] | None |
| query | sort
optional | Comma-separated list of sort keys and optional sort directions in the form of [:]
Example : created_at:desc
| any of [string, null] | created_at:desc |
| query | auto_scaling_group_id
optional | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | ServerListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/servers
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"servers": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"addresses": [
{
"ip_addresses": [
{
"ip_address": "192.169.3.2",
"version": 4
}
],
"subnet_name": "subnetname"
}
],
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2026-04-14T15:06:21.878Z",
"created_by": "97e6b22c9a4143789ca522df7457a32f",
"disk_config": "MANUAL",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"is_marketplace": false,
"keypair_name": "keypairname",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"locked": false,
"metadata": "",
"modified_at": "2026-04-14T15:06:21.878Z",
"name": "servername",
"partition_number": 1,
"planned_compute_os_type": "windows",
"product_category": "compute",
"product_offering": "virtual_server",
"security_groups": [
{
"name": "securitygroup"
}
],
"server_group_id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"server_type": {
"disk": 100,
"ephemeral": 0,
"extra_specs": "",
"id": "s1v1m2",
"name": "s1v1m2",
"ram": 2,
"swap": 0,
"vcpus": 1
},
"state": "ACTIVE",
"volumes": [
{
"delete_on_termination": false,
"id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
],
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
]
}
1.66 - List volume transfers
1.66.1 - 1.2
get /v1/volume-transfer
Description
List volume transfers.
State
ACTIVE (CURRENT)
Responses
Example HTTP request
Request path
/v1/volume-transfer
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"transfers": [
{
"id": "1ac231be-823b-4a4d-8ff0-aac503a7118a",
"name": "volume01",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
]
}
1.66.2 - 1.1
get /v1/volume-transfer
Description
List volume transfers.
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 |
Responses
Example HTTP request
Request path
/v1/volume-transfer
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"transfers": [
{
"id": "1ac231be-823b-4a4d-8ff0-aac503a7118a",
"name": "volume01",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
]
}
1.66.3 - 1.0
get /v1/volume-transfer
Description
List volume transfers.
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 |
Responses
Example HTTP request
Request path
/v1/volume-transfer
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"transfers": [
{
"id": "1ac231be-823b-4a4d-8ff0-aac503a7118a",
"name": "volume01",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
]
}
1.67 - List volume types
1.67.1 - 1.2
get /v1/volume-types
Description
List volume types.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| query | limit
optional | Page size of items. Max value is 1000.
Example : 20
| any of [integer, null] | 20 |
| query | offset
optional | Index of where to start in the list
Example : 0
| any of [integer, null] | None |
| query | marker
optional | The last item’s ID from previous request
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| any of [string, null] | None |
| query | sort
optional | Comma-separated list of sort keys and optional sort directions in the form of [:]
Example : created_at:desc
| any of [string, null] | name:asc |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | VolumeTypeListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 500 | Internal Server Error | None |
Example HTTP request
Request path
/v1/volume-types
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"volume_types": [
{
"description": "Volume type description",
"extra_specs": {
"multiattach": "<is> True"
},
"id": "c643ac35-3aec-43e6-b97a-3d6f666c5207",
"name": "SSD"
}
]
}
1.67.2 - 1.1
get /v1/volume-types
Description
List volume types.
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
| Type | Name | Description | Schema | Default |
|---|
| query | limit
optional | Page size of items. Max value is 1000.
Example : 20
| any of [integer, null] | 20 |
| query | offset
optional | Index of where to start in the list
Example : 0
| any of [integer, null] | None |
| query | marker
optional | The last item’s ID from previous request
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| any of [string, null] | None |
| query | sort
optional | Comma-separated list of sort keys and optional sort directions in the form of [:]
Example : created_at:desc
| any of [string, null] | name:asc |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | VolumeTypeListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 500 | Internal Server Error | None |
Example HTTP request
Request path
/v1/volume-types
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"volume_types": [
{
"description": "Volume type description",
"extra_specs": {
"multiattach": "<is> True"
},
"id": "c643ac35-3aec-43e6-b97a-3d6f666c5207",
"name": "SSD"
}
]
}
1.67.3 - 1.0
get /v1/volume-types
Description
List volume types.
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
| Type | Name | Description | Schema | Default |
|---|
| query | limit
optional | Page size of items. Max value is 1000.
Example : 20
| any of [integer, null] | 20 |
| query | offset
optional | Index of where to start in the list
Example : 0
| any of [integer, null] | None |
| query | marker
optional | The last item’s ID from previous request
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| any of [string, null] | None |
| query | sort
optional | Comma-separated list of sort keys and optional sort directions in the form of [:]
Example : created_at:desc
| any of [string, null] | name:asc |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | VolumeTypeListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 500 | Internal Server Error | None |
Example HTTP request
Request path
/v1/volume-types
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"volume_types": [
{
"description": "Volume type description",
"extra_specs": {
"multiattach": "<is> True"
},
"id": "c643ac35-3aec-43e6-b97a-3d6f666c5207",
"name": "SSD"
}
]
}
1.68 - List volumes
1.68.1 - 1.2
get /v1/volumes
Description
List volumes.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| query | with_count
optional | Whether to show count
Example : True
| any of [boolean, null] | True |
| query | limit
optional | Page size of items. Max value is 1000.
Example : 20
| any of [integer, null] | 20 |
| query | marker
optional | The last item’s ID from previous request
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| any of [string, null] | None |
| query | sort
optional | Comma-separated list of sort keys and optional sort directions in the form of [:]
Example : created_at:desc
| any of [string, null] | None |
| query | offset
optional | Index of where to start in the list
Example : 0
| any of [integer, null] | None |
| query | name
optional | Volume name
Example : volume01
| any of [string, null] | None |
| query | state
optional | Volume state
Example : available
| any of [string, null] | None |
| query | bootable
optional | Bootable
Example : False
| any of [boolean, null] | None |
Responses
Example HTTP request
Request path
/v1/volumes
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"count": 100,
"volumes": [
{
"bootable": false,
"created_at": "2026-04-14T15:06:27.979Z",
"encrypted": true,
"id": "3f500f00-ed80-4566-a057-e31760226f9a",
"max_iops": 10000,
"max_throughput": 500,
"modified_at": "2025-07-26T12:00:00Z",
"multiattach": false,
"name": "volume01",
"servers": [
{
"attached_at": "2026-04-14T15:06:27.979Z",
"device": "/dev/vda",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
}
],
"size": 104,
"snapshot_id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"state": "available",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_image_metadata": {
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"disk_format": "qcow2",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"min_disk": 100,
"min_ram": 0,
"os_distro": "alma",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"signature_verified": false,
"size": 2429747200
},
"volume_type": "SSD",
"volume_type_id": "c643ac35-3aec-43e6-b97a-3d6f666c5207"
}
]
}
1.68.2 - 1.1
get /v1/volumes
Description
List volumes.
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
| Type | Name | Description | Schema | Default |
|---|
| query | with_count
optional | Whether to show count
Example : True
| any of [boolean, null] | True |
| query | limit
optional | Page size of items. Max value is 1000.
Example : 20
| any of [integer, null] | 20 |
| query | marker
optional | The last item’s ID from previous request
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| any of [string, null] | None |
| query | sort
optional | Comma-separated list of sort keys and optional sort directions in the form of [:]
Example : created_at:desc
| any of [string, null] | None |
| query | offset
optional | Index of where to start in the list
Example : 0
| any of [integer, null] | None |
| query | name
optional | Volume name
Example : volume01
| any of [string, null] | None |
| query | state
optional | Volume state
Example : available
| any of [string, null] | None |
| query | bootable
optional | Bootable
Example : False
| any of [boolean, null] | None |
Responses
Example HTTP request
Request path
/v1/volumes
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"count": 100,
"volumes": [
{
"bootable": false,
"created_at": "2026-04-14T15:06:25.481Z",
"encrypted": true,
"id": "3f500f00-ed80-4566-a057-e31760226f9a",
"modified_at": "2025-07-26T12:00:00Z",
"multiattach": false,
"name": "volume01",
"servers": [
{
"attached_at": "2026-04-14T15:06:25.481Z",
"device": "/dev/vda",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
}
],
"size": 104,
"snapshot_id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"state": "available",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_image_metadata": {
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"disk_format": "qcow2",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"min_disk": 100,
"min_ram": 0,
"os_distro": "alma",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"signature_verified": false,
"size": 2429747200
},
"volume_type": "SSD",
"volume_type_id": "c643ac35-3aec-43e6-b97a-3d6f666c5207"
}
]
}
1.68.3 - 1.0
get /v1/volumes
Description
List volumes.
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
| Type | Name | Description | Schema | Default |
|---|
| query | with_count
optional | Whether to show count
Example : True
| any of [boolean, null] | True |
| query | limit
optional | Page size of items. Max value is 1000.
Example : 20
| any of [integer, null] | 20 |
| query | marker
optional | The last item’s ID from previous request
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| any of [string, null] | None |
| query | sort
optional | Comma-separated list of sort keys and optional sort directions in the form of [:]
Example : created_at:desc
| any of [string, null] | None |
| query | offset
optional | Index of where to start in the list
Example : 0
| any of [integer, null] | None |
| query | name
optional | Volume name
Example : volume01
| any of [string, null] | None |
| query | state
optional | Volume state
Example : available
| any of [string, null] | None |
| query | bootable
optional | Bootable
Example : False
| any of [boolean, null] | None |
Responses
Example HTTP request
Request path
/v1/volumes
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"count": 100,
"volumes": [
{
"bootable": false,
"created_at": "2026-04-14T15:06:22.983Z",
"encrypted": true,
"id": "3f500f00-ed80-4566-a057-e31760226f9a",
"modified_at": "2025-07-26T12:00:00Z",
"multiattach": false,
"name": "volume01",
"servers": [
{
"attached_at": "2026-04-14T15:06:22.983Z",
"device": "/dev/vda",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
}
],
"size": 104,
"snapshot_id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"state": "available",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_image_metadata": {
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"disk_format": "qcow2",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"min_disk": 100,
"min_ram": 0,
"os_distro": "alma",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"signature_verified": false,
"size": 2429747200
},
"volume_type": "SSD",
"volume_type_id": "c643ac35-3aec-43e6-b97a-3d6f666c5207"
}
]
}
1.69 - Lock Virtual Server
1.69.1 - 1.2
post /v1/servers/{server_id}/lock
Description
Lock Virtual Server.
The lock prevents actions such as terminate/start/stop the server from being executed, preventing accidental actions.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/lock
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 202
1.69.2 - 1.1
post /v1/servers/{server_id}/lock
Description
Lock Virtual Server.
The lock prevents actions such as terminate/start/stop the server from being executed, preventing accidental actions.
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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/lock
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 202
1.69.3 - 1.0
post /v1/servers/{server_id}/lock
Description
Lock Virtual Server.
The lock prevents actions such as terminate/start/stop the server from being executed, preventing accidental actions.
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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/lock
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 202
1.70 - Reboot Virtual Server
1.70.1 - 1.2
post /v1/servers/{server_id}/reboot
Description
Reboot Virtual Server.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
| body | body
required |
| ServerRebootRequestBody | |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/reboot
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"reboot_type": "SOFT"
}
Example HTTP response
Response 202
1.70.2 - 1.1
post /v1/servers/{server_id}/reboot
Description
Reboot 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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
| body | body
required |
| ServerRebootRequestBody | |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/reboot
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"reboot_type": "SOFT"
}
Example HTTP response
Response 202
1.70.3 - 1.0
post /v1/servers/{server_id}/reboot
Description
Reboot 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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
| body | body
required |
| ServerRebootRequestBody | |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/reboot
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"reboot_type": "SOFT"
}
Example HTTP response
Response 202
1.71 - Rebuild Virtual Server
1.71.1 - 1.2
post /v1/servers/{server_id}/rebuild
Description
Rebuild Virtual Server.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/rebuild
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 202
1.71.2 - 1.1
post /v1/servers/{server_id}/rebuild
Description
Rebuild 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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/rebuild
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 202
1.71.3 - 1.0
post /v1/servers/{server_id}/rebuild
Description
Rebuild 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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/rebuild
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 202
1.72 - Revert Volume to snapshot
1.72.1 - 1.2
post /v1/volumes/{volume_id}/revert
Description
Revert a volume to its latest snapshot, this API only support reverting a detached volume, and the volume status must be available.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume ID
Example : 3f500f00-ed80-4566-a057-e31760226f9a
| string | None |
| body | body
required |
| VolumeRevertRequest | |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/volumes/{volume_id}/revert
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"snapshot_id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790"
}
Example HTTP response
Response 202
1.72.2 - 1.1
post /v1/volumes/{volume_id}/revert
Description
Revert a volume to its latest snapshot, this API only support reverting a detached volume, and the volume status must be available.
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
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume ID
Example : 3f500f00-ed80-4566-a057-e31760226f9a
| string | None |
| body | body
required |
| VolumeRevertRequest | |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/volumes/{volume_id}/revert
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"snapshot_id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790"
}
Example HTTP response
Response 202
1.72.3 - 1.0
post /v1/volumes/{volume_id}/revert
Description
Revert a volume to its latest snapshot, this API only support reverting a detached volume, and the volume status must be available.
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
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume ID
Example : 3f500f00-ed80-4566-a057-e31760226f9a
| string | None |
| body | body
required |
| VolumeRevertRequest | |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/volumes/{volume_id}/revert
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"snapshot_id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790"
}
Example HTTP response
Response 202
1.73 - Set Volume Qos
1.73.1 - 1.2
put /v1/volumes/{volume_id}/qos
Description
Set Volume Qos
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume ID
Example : 3f500f00-ed80-4566-a057-e31760226f9a
| string | None |
| body | body
required |
| VolumeSetQosRequest | |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/volumes/{volume_id}/qos
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"max_iops": 10000,
"max_throughput": 500
}
Example HTTP response
Response 202
1.74 - Show a snapshot’s details
1.74.1 - 1.2
get /v1/snapshots/{snapshot_id}
Description
Show a snapshot’s details.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | snapshot_id
required | Snapshot ID
Example : cceed636-1f1e-4bb0-b85c-4e5b9e0bf790
| string | None |
Responses
Example HTTP request
Request path
/v1/snapshots/{snapshot_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"created_at": "2025-07-22T09:00:00Z",
"description": "description",
"id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"metadata": "Metadata",
"name": "snapshot-1",
"size": 104,
"status": "available",
"updated_at": "2025-07-26T12:00:00Z",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
1.74.2 - 1.1
get /v1/snapshots/{snapshot_id}
Description
Show a snapshot’s details.
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
| Type | Name | Description | Schema | Default |
|---|
| path | snapshot_id
required | Snapshot ID
Example : cceed636-1f1e-4bb0-b85c-4e5b9e0bf790
| string | None |
Responses
Example HTTP request
Request path
/v1/snapshots/{snapshot_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"created_at": "2025-07-22T09:00:00Z",
"description": "description",
"id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"metadata": "Metadata",
"name": "snapshot-1",
"size": 104,
"status": "available",
"updated_at": "2025-07-26T12:00:00Z",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
1.74.3 - 1.0
get /v1/snapshots/{snapshot_id}
Description
Show a snapshot’s details.
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
| Type | Name | Description | Schema | Default |
|---|
| path | snapshot_id
required | Snapshot ID
Example : cceed636-1f1e-4bb0-b85c-4e5b9e0bf790
| string | None |
Responses
Example HTTP request
Request path
/v1/snapshots/{snapshot_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"created_at": "2025-07-22T09:00:00Z",
"description": "description",
"id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"metadata": "Metadata",
"name": "snapshot-1",
"size": 104,
"status": "available",
"updated_at": "2025-07-26T12:00:00Z",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
1.75 - Show Auto-Scaling Group
1.75.1 - 1.2
get /v1/auto-scaling-groups/{auto_scaling_group_id}
Description
Show Auto-Scaling Group.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | None |
Responses
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"desired_server_count": 1,
"desired_server_count_editable": true,
"drain_enabled": true,
"drain_timeout": 300,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"launch_configuration_name": "launch-configuration-name",
"lb_server_groups": [],
"max_server_count": 2,
"min_server_count": 1,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "auto-scaling-group-name",
"security_group_ids": [
"c09c3f05-03d9-443f-b27a-40e0f973c75f"
],
"server_name_prefix": "server-name-prefix",
"state": "IN_SERVICE",
"state_check_delay_time": 300,
"subnet_ids": [],
"total_server_count": 1,
"use_lb_state_check": true,
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
1.75.2 - 1.1
get /v1/auto-scaling-groups/{auto_scaling_group_id}
Description
Show Auto-Scaling Group.
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
| Type | Name | Description | Schema | Default |
|---|
| path | auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | None |
Responses
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"desired_server_count": 1,
"desired_server_count_editable": true,
"drain_enabled": true,
"drain_timeout": 300,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"launch_configuration_name": "launch-configuration-name",
"lb_server_groups": [],
"max_server_count": 2,
"min_server_count": 1,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "auto-scaling-group-name",
"security_group_ids": [
"c09c3f05-03d9-443f-b27a-40e0f973c75f"
],
"server_name_prefix": "server-name-prefix",
"state": "IN_SERVICE",
"subnet_ids": [],
"total_server_count": 1,
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
1.75.3 - 1.0
get /v1/auto-scaling-groups/{auto_scaling_group_id}
Description
Show Auto-Scaling Group.
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
| Type | Name | Description | Schema | Default |
|---|
| path | auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | None |
Responses
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"desired_server_count": 1,
"desired_server_count_editable": true,
"drain_enabled": true,
"drain_timeout": 300,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"launch_configuration_name": "launch-configuration-name",
"lb_server_groups": [],
"max_server_count": 2,
"min_server_count": 1,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "auto-scaling-group-name",
"security_group_ids": [
"c09c3f05-03d9-443f-b27a-40e0f973c75f"
],
"server_name_prefix": "server-name-prefix",
"state": "IN_SERVICE",
"subnet_ids": [],
"total_server_count": 1,
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
1.76 - Show Auto-Scaling Group Notification
1.76.1 - 1.2
get /v1/auto-scaling-groups/{auto_scaling_group_id}/notifications/{notification_id}
Description
Show Auto-Scaling Group notification.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | None |
| path | notification_id
required | Auto-Scaling Group notification ID
Example : fa7fd191410744cd810a290c0b4d22b9
| string | None |
Responses
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/notifications/{notification_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"notification_events": [
"SCALE_OUT",
"SCALE_OUT_FAIL"
],
"notification_state": "ACTIVE",
"user_email": "scpuser@samsung.com",
"user_id": "570907805e5447be84b618450ef52o0t",
"user_name": "scpuser"
}
1.76.2 - 1.1
get /v1/auto-scaling-groups/{auto_scaling_group_id}/notifications/{notification_id}
Description
Show Auto-Scaling Group notification.
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
| Type | Name | Description | Schema | Default |
|---|
| path | auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | None |
| path | notification_id
required | Auto-Scaling Group notification ID
Example : fa7fd191410744cd810a290c0b4d22b9
| string | None |
Responses
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/notifications/{notification_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"notification_events": [
"SCALE_OUT",
"SCALE_OUT_FAIL"
],
"notification_state": "ACTIVE",
"user_email": "scpuser@samsung.com",
"user_id": "570907805e5447be84b618450ef52o0t",
"user_name": "scpuser"
}
1.76.3 - 1.0
get /v1/auto-scaling-groups/{auto_scaling_group_id}/notifications/{notification_id}
Description
Show Auto-Scaling Group notification.
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
| Type | Name | Description | Schema | Default |
|---|
| path | auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | None |
| path | notification_id
required | Auto-Scaling Group notification ID
Example : fa7fd191410744cd810a290c0b4d22b9
| string | None |
Responses
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/notifications/{notification_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"notification_events": [
"SCALE_OUT",
"SCALE_OUT_FAIL"
],
"notification_state": "ACTIVE",
"user_email": "scpuser@samsung.com",
"user_id": "570907805e5447be84b618450ef52o0t",
"user_name": "scpuser"
}
1.77 - Show Auto-Scaling Group Policy
1.77.1 - 1.2
get /v1/auto-scaling-groups/{auto_scaling_group_id}/policies/{policy_id}
Description
Show Auto-Scaling Group policy.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | None |
| path | policy_id
required | Policy ID
Example : 0761d76085f54363bab07909baf69841
| string | None |
Responses
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/policies/{policy_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"comparison_operator": "ge",
"cooldown_seconds": 300,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"evaluation_minutes": 5,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"metric_method": "AVG",
"metric_type": "CPU",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "policy-name",
"scale_method": "AMOUNT",
"scale_type": "SCALE_OUT",
"scale_value": 10,
"state": "ACTIVE",
"threshold": 60,
"threshold_unit": "%"
}
1.77.2 - 1.1
get /v1/auto-scaling-groups/{auto_scaling_group_id}/policies/{policy_id}
Description
Show Auto-Scaling Group policy.
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
| Type | Name | Description | Schema | Default |
|---|
| path | auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | None |
| path | policy_id
required | Policy ID
Example : 0761d76085f54363bab07909baf69841
| string | None |
Responses
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/policies/{policy_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"comparison_operator": "ge",
"cooldown_seconds": 300,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"evaluation_minutes": 5,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"metric_method": "AVG",
"metric_type": "CPU",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "policy-name",
"scale_method": "AMOUNT",
"scale_type": "SCALE_OUT",
"scale_value": 10,
"state": "ACTIVE",
"threshold": 60,
"threshold_unit": "%"
}
1.77.3 - 1.0
get /v1/auto-scaling-groups/{auto_scaling_group_id}/policies/{policy_id}
Description
Show Auto-Scaling Group policy.
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
| Type | Name | Description | Schema | Default |
|---|
| path | auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | None |
| path | policy_id
required | Policy ID
Example : 0761d76085f54363bab07909baf69841
| string | None |
Responses
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/policies/{policy_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"comparison_operator": "ge",
"cooldown_seconds": 300,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"evaluation_minutes": 5,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"metric_method": "AVG",
"metric_type": "CPU",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "policy-name",
"scale_method": "AMOUNT",
"scale_type": "SCALE_OUT",
"scale_value": 10,
"state": "ACTIVE",
"threshold": 60,
"threshold_unit": "%"
}
1.78 - Show Auto-Scaling Group Schedule
1.78.1 - 1.2
get /v1/auto-scaling-groups/{auto_scaling_group_id}/schedules/{schedule_id}
Description
Show Auto-Scaling Group schedule.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | None |
| path | schedule_id
required | Schedule ID
Example : 43d4841abd404220af5f0904037aba71
| string | None |
Responses
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/schedules/{schedule_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"day_of_month": "-1,1",
"day_of_week": "SU,SA",
"description": "description",
"desired_server_count": 1,
"end_date": "2025-01-01",
"frequency": "WEEKLY",
"hour": 9,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"max_server_count": 2,
"min_server_count": 1,
"minute": 0,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "schedulename",
"start_date": "2024-01-01",
"state": "ACTIVE",
"timezone": "Asia/Seoul"
}
1.78.2 - 1.1
get /v1/auto-scaling-groups/{auto_scaling_group_id}/schedules/{schedule_id}
Description
Show Auto-Scaling Group schedule.
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
| Type | Name | Description | Schema | Default |
|---|
| path | auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | None |
| path | schedule_id
required | Schedule ID
Example : 43d4841abd404220af5f0904037aba71
| string | None |
Responses
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/schedules/{schedule_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"day_of_month": "-1,1",
"day_of_week": "SU,SA",
"description": "description",
"desired_server_count": 1,
"end_date": "2025-01-01",
"frequency": "WEEKLY",
"hour": 9,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"max_server_count": 2,
"min_server_count": 1,
"minute": 0,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "schedulename",
"start_date": "2024-01-01",
"state": "ACTIVE",
"timezone": "Asia/Seoul"
}
1.78.3 - 1.0
get /v1/auto-scaling-groups/{auto_scaling_group_id}/schedules/{schedule_id}
Description
Show Auto-Scaling Group schedule.
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
| Type | Name | Description | Schema | Default |
|---|
| path | auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | None |
| path | schedule_id
required | Schedule ID
Example : 43d4841abd404220af5f0904037aba71
| string | None |
Responses
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/schedules/{schedule_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"day_of_month": "-1,1",
"day_of_week": "SU,SA",
"description": "description",
"desired_server_count": 1,
"end_date": "2025-01-01",
"frequency": "WEEKLY",
"hour": 9,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"max_server_count": 2,
"min_server_count": 1,
"minute": 0,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "schedulename",
"start_date": "2024-01-01",
"state": "ACTIVE",
"timezone": "Asia/Seoul"
}
1.79 - Show default Volume type’s details
1.79.1 - 1.2
get /v1/volume-types/default
Description
Show a default Volume type’s details.
State
ACTIVE (CURRENT)
Responses
Example HTTP request
Request path
/v1/volume-types/default
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"description": "Volume type description",
"extra_specs": {
"multiattach": "<is> True"
},
"id": "c643ac35-3aec-43e6-b97a-3d6f666c5207",
"name": "SSD"
}
1.79.2 - 1.1
get /v1/volume-types/default
Description
Show a default Volume type’s details.
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 |
Responses
Example HTTP request
Request path
/v1/volume-types/default
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"description": "Volume type description",
"extra_specs": {
"multiattach": "<is> True"
},
"id": "c643ac35-3aec-43e6-b97a-3d6f666c5207",
"name": "SSD"
}
1.79.3 - 1.0
get /v1/volume-types/default
Description
Show a default Volume type’s details.
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 |
Responses
Example HTTP request
Request path
/v1/volume-types/default
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"description": "Volume type description",
"extra_specs": {
"multiattach": "<is> True"
},
"id": "c643ac35-3aec-43e6-b97a-3d6f666c5207",
"name": "SSD"
}
1.80 - Show Image
1.80.1 - 1.2
get /v1/images/{image_id}
Description
Show Image.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | image_id
required | Image ID
Example : 70a599e0-31e7-49b7-b260-868f441e862b
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | ImageShowResponseV1Dot2 |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/images/{image_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"created_at": "2025-07-22T09:00:00Z",
"disk_format": "qcow2",
"file": "/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file",
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"min_disk": 100,
"min_ram": 0,
"name": "imagename",
"os_distro": "alma",
"os_hash_algo": "sha512",
"os_hash_value": "c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99",
"os_hidden": false,
"owner": "a8f10467abfc4b87b64614ab36eb9ae4",
"owner_account_name": "AccountName",
"owner_user_name": "user@samsung.com",
"protected": false,
"root_device_name": "/dev/vda",
"scp_gpu_driver": "535.183.06",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"scp_os_build_version": "20250101",
"scp_os_version": "8.8",
"size": 2429747200,
"status": "active",
"updated_at": "2025-07-26T12:00:00Z",
"url": "https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2",
"virtual_size": 17179869184,
"visibility": "private",
"volumes": "[{\"tag\": null, \"volume_id\": null, \"encryption_options\": null, \"encryption_secret_uuid\": null, \"encryption_format\": null, \"device_name\": \"/dev/vda\", \"disk_bus\": \"virtio\", \"volume_type\": null, \"encrypted\": null, \"image_id\": null, \"device_type\": \"disk\", \"source_type\": \"snapshot\", \"delete_on_termination\": false, \"volume_size\": 104, \"guest_format\": null, \"boot_index\": 0, \"destination_type\": \"volume\", \"snapshot_id\": \"abde9e38-2ed5-4ecd-b23c-b0120e30690e\", \"no_device\": null}]"
}
1.80.2 - 1.1
get /v1/images/{image_id}
Description
Show Image.
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
| Type | Name | Description | Schema | Default |
|---|
| path | image_id
required | Image ID
Example : 70a599e0-31e7-49b7-b260-868f441e862b
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | ImageShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/images/{image_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"created_at": "2025-07-22T09:00:00Z",
"disk_format": "qcow2",
"file": "/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file",
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"min_disk": 100,
"min_ram": 0,
"name": "imagename",
"os_distro": "alma",
"os_hash_algo": "sha512",
"os_hash_value": "c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99",
"os_hidden": false,
"owner": "a8f10467abfc4b87b64614ab36eb9ae4",
"owner_account_name": "AccountName",
"owner_user_name": "user@samsung.com",
"protected": false,
"root_device_name": "/dev/vda",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"scp_os_build_version": "20250101",
"scp_os_version": "8.8",
"size": 2429747200,
"status": "active",
"updated_at": "2025-07-26T12:00:00Z",
"url": "https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2",
"virtual_size": 17179869184,
"visibility": "private",
"volumes": "[{\"tag\": null, \"volume_id\": null, \"encryption_options\": null, \"encryption_secret_uuid\": null, \"encryption_format\": null, \"device_name\": \"/dev/vda\", \"disk_bus\": \"virtio\", \"volume_type\": null, \"encrypted\": null, \"image_id\": null, \"device_type\": \"disk\", \"source_type\": \"snapshot\", \"delete_on_termination\": false, \"volume_size\": 104, \"guest_format\": null, \"boot_index\": 0, \"destination_type\": \"volume\", \"snapshot_id\": \"abde9e38-2ed5-4ecd-b23c-b0120e30690e\", \"no_device\": null}]"
}
1.80.3 - 1.0
get /v1/images/{image_id}
Description
Show Image.
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
| Type | Name | Description | Schema | Default |
|---|
| path | image_id
required | Image ID
Example : 70a599e0-31e7-49b7-b260-868f441e862b
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | ImageShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/images/{image_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"created_at": "2025-07-22T09:00:00Z",
"disk_format": "qcow2",
"file": "/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file",
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"min_disk": 100,
"min_ram": 0,
"name": "imagename",
"os_distro": "alma",
"os_hash_algo": "sha512",
"os_hash_value": "c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99",
"os_hidden": false,
"owner": "a8f10467abfc4b87b64614ab36eb9ae4",
"owner_account_name": "AccountName",
"owner_user_name": "user@samsung.com",
"protected": false,
"root_device_name": "/dev/vda",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"scp_os_build_version": "20250101",
"scp_os_version": "8.8",
"size": 2429747200,
"status": "active",
"updated_at": "2025-07-26T12:00:00Z",
"url": "https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2",
"virtual_size": 17179869184,
"visibility": "private",
"volumes": "[{\"tag\": null, \"volume_id\": null, \"encryption_options\": null, \"encryption_secret_uuid\": null, \"encryption_format\": null, \"device_name\": \"/dev/vda\", \"disk_bus\": \"virtio\", \"volume_type\": null, \"encrypted\": null, \"image_id\": null, \"device_type\": \"disk\", \"source_type\": \"snapshot\", \"delete_on_termination\": false, \"volume_size\": 104, \"guest_format\": null, \"boot_index\": 0, \"destination_type\": \"volume\", \"snapshot_id\": \"abde9e38-2ed5-4ecd-b23c-b0120e30690e\", \"no_device\": null}]"
}
1.81 - Show Image member
1.81.1 - 1.2
get /v1/images/{image_id}/members/{member_id}
Description
Show Image member.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | image_id
required | Image ID
Example : 70a599e0-31e7-49b7-b260-868f441e862b
| string | None |
| path | member_id
required | Shared Image member ID
Example : a8f10467abfc4b87b64614ab36eb9ae4
| string | None |
Responses
Example HTTP request
Request path
/v1/images/{image_id}/members/{member_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"created_at": "2025-07-22T09:00:00Z",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"member_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"status": "pending",
"updated_at": "2025-07-26T12:00:00Z"
}
1.81.2 - 1.1
get /v1/images/{image_id}/members/{member_id}
Description
Show Image member.
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
| Type | Name | Description | Schema | Default |
|---|
| path | image_id
required | Image ID
Example : 70a599e0-31e7-49b7-b260-868f441e862b
| string | None |
| path | member_id
required | Shared Image member ID
Example : a8f10467abfc4b87b64614ab36eb9ae4
| string | None |
Responses
Example HTTP request
Request path
/v1/images/{image_id}/members/{member_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"created_at": "2025-07-22T09:00:00Z",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"member_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"status": "pending",
"updated_at": "2025-07-26T12:00:00Z"
}
1.81.3 - 1.0
get /v1/images/{image_id}/members/{member_id}
Description
Show Image member.
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
| Type | Name | Description | Schema | Default |
|---|
| path | image_id
required | Image ID
Example : 70a599e0-31e7-49b7-b260-868f441e862b
| string | None |
| path | member_id
required | Shared Image member ID
Example : a8f10467abfc4b87b64614ab36eb9ae4
| string | None |
Responses
Example HTTP request
Request path
/v1/images/{image_id}/members/{member_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"created_at": "2025-07-22T09:00:00Z",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"member_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"status": "pending",
"updated_at": "2025-07-26T12:00:00Z"
}
1.82 - Show Keypair
1.82.1 - 1.2
get /v1/keypairs/{keypair_name}
Description
Show keypair.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | keypair_name
required | Keypair name
Example : keypairname
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | KeypairShowResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/keypairs/{keypair_name}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"created_at": "2025-07-22T09:00:00Z",
"fingerprint": "7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd",
"id": 1,
"name": "keypairname",
"public_key": "ssh-rsa fakeKey Generated-by-SCP",
"type": "ssh",
"user_id": "570907805e5447be84b618450ef52o0t"
}
1.82.2 - 1.1
get /v1/keypairs/{keypair_name}
Description
Show keypair.
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
| Type | Name | Description | Schema | Default |
|---|
| path | keypair_name
required | Keypair name
Example : keypairname
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | KeypairShowResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/keypairs/{keypair_name}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"created_at": "2025-07-22T09:00:00Z",
"fingerprint": "7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd",
"id": 1,
"name": "keypairname",
"public_key": "ssh-rsa fakeKey Generated-by-SCP",
"type": "ssh",
"user_id": "570907805e5447be84b618450ef52o0t"
}
1.82.3 - 1.0
get /v1/keypairs/{keypair_name}
Description
Show keypair.
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
| Type | Name | Description | Schema | Default |
|---|
| path | keypair_name
required | Keypair name
Example : keypairname
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | KeypairShowResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/keypairs/{keypair_name}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"created_at": "2025-07-22T09:00:00Z",
"fingerprint": "7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd",
"id": 1,
"name": "keypairname",
"public_key": "ssh-rsa fakeKey Generated-by-SCP",
"type": "ssh",
"user_id": "570907805e5447be84b618450ef52o0t"
}
1.83 - Show Launch Configuration
1.83.1 - 1.2
get /v1/launch-configurations/{launch_configuration_id}
Description
Show Launch Configuration.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | launch_configuration_id
required | Launch Configuration ID
Example : b5aea5a675fc4f6b9e0fcd1288354c5f
| string | None |
Responses
Example HTTP request
Request path
/v1/launch-configurations/{launch_configuration_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_count": 1,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"file_storage_ids": [
""
],
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"keypair_name": "keypairname",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "launch-configuration-name",
"public_key": "ssh-rsa fakeKey Generated-by-SCP",
"server_type_id": "s1v1m2",
"state": "ACTIVE",
"user_data": "IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==",
"volumes": [
{
"boot_index": 0,
"max_iops": 10000,
"max_throughput": 500,
"size": 104,
"type": "SSD"
}
]
}
1.83.2 - 1.1
get /v1/launch-configurations/{launch_configuration_id}
Description
Show Launch Configuration.
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
| Type | Name | Description | Schema | Default |
|---|
| path | launch_configuration_id
required | Launch Configuration ID
Example : b5aea5a675fc4f6b9e0fcd1288354c5f
| string | None |
Responses
Example HTTP request
Request path
/v1/launch-configurations/{launch_configuration_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_count": 1,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"keypair_name": "keypairname",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "launch-configuration-name",
"public_key": "ssh-rsa fakeKey Generated-by-SCP",
"server_type_id": "s1v1m2",
"state": "ACTIVE",
"user_data": "IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==",
"volumes": [
{
"boot_index": 0,
"size": 104,
"type": "SSD"
}
]
}
1.83.3 - 1.0
get /v1/launch-configurations/{launch_configuration_id}
Description
Show Launch Configuration.
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
| Type | Name | Description | Schema | Default |
|---|
| path | launch_configuration_id
required | Launch Configuration ID
Example : b5aea5a675fc4f6b9e0fcd1288354c5f
| string | None |
Responses
Example HTTP request
Request path
/v1/launch-configurations/{launch_configuration_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_count": 1,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"keypair_name": "keypairname",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "launch-configuration-name",
"public_key": "ssh-rsa fakeKey Generated-by-SCP",
"server_type_id": "s1v1m2",
"state": "ACTIVE",
"user_data": "IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==",
"volumes": [
{
"boot_index": 0,
"size": 104,
"type": "SSD"
}
]
}
1.84 - Show Server Group
1.84.1 - 1.2
get /v1/server-groups/{server_group_id}
Description
Show server group.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | server_group_id
required | Server Group ID
Example : 616fb98f-46ca-475e-917e-2563e5a8cd19
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | ServerGroup |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/server-groups/{server_group_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"members": [
"2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
],
"name": "server-group",
"partition_size": 3,
"policy": "anti-affinity",
"user_id": "570907805e5447be84b618450ef52o0t"
}
1.84.2 - 1.1
get /v1/server-groups/{server_group_id}
Description
Show server group.
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
| Type | Name | Description | Schema | Default |
|---|
| path | server_group_id
required | Server Group ID
Example : 616fb98f-46ca-475e-917e-2563e5a8cd19
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | ServerGroup |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/server-groups/{server_group_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"members": [
"2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
],
"name": "server-group",
"partition_size": 3,
"policy": "anti-affinity",
"user_id": "570907805e5447be84b618450ef52o0t"
}
1.84.3 - 1.0
get /v1/server-groups/{server_group_id}
Description
Show server group.
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
| Type | Name | Description | Schema | Default |
|---|
| path | server_group_id
required | Server Group ID
Example : 616fb98f-46ca-475e-917e-2563e5a8cd19
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | ServerGroup |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/server-groups/{server_group_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"members": [
"2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
],
"name": "server-group",
"partition_size": 3,
"policy": "anti-affinity",
"user_id": "570907805e5447be84b618450ef52o0t"
}
1.85 - Show Server Interface
1.85.1 - 1.2
get /v1/servers/{server_id}/interfaces/{port_id}
Description
Show Server Interface.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
| path | port_id
required | Port ID
Example : 91424c08-0b26-49fb-9808-ed042292ceef
| string | None |
Responses
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces/{port_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"interfaces": [
{
"fixed_ips": [
{
"ip_address": "192.169.3.2"
}
],
"is_default": true,
"mac_addr": "fa:16:3e:c0:71:2b",
"port_id": "f2b02fc5-a5fd-4b5f-b1a9-987f4c0d66cc",
"port_state": "ACTIVE",
"private_static_nat": {
"external_ip_address": "182.197.61.81",
"id": "224b80106e6f41b38efe98ac9ddbf280",
"private_nat_ip_id": "1f0cb5390c40483592ddc5a282f53496",
"state": "ACTIVE"
},
"static_nat": {
"external_ip_address": "182.197.61.81",
"id": "224b80106e6f41b38efe98ac9ddbf280",
"publicip_id": "615fa9cd5cff486c9de679b3ce63e601",
"state": "ACTIVE"
},
"subnet_id": "183c6c30df0c4fcbb16422aa2d64aa21"
}
]
}
1.85.2 - 1.1
get /v1/servers/{server_id}/interfaces/{port_id}
Description
Show Server Interface.
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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
| path | port_id
required | Port ID
Example : 91424c08-0b26-49fb-9808-ed042292ceef
| string | None |
Responses
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces/{port_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"interfaces": [
{
"fixed_ips": [
{
"ip_address": "192.169.3.2"
}
],
"mac_addr": "fa:16:3e:c0:71:2b",
"port_id": "f2b02fc5-a5fd-4b5f-b1a9-987f4c0d66cc",
"port_state": "ACTIVE",
"private_static_nat": {
"external_ip_address": "182.197.61.81",
"id": "224b80106e6f41b38efe98ac9ddbf280",
"private_nat_ip_id": "1f0cb5390c40483592ddc5a282f53496",
"state": "ACTIVE"
},
"static_nat": {
"external_ip_address": "182.197.61.81",
"id": "224b80106e6f41b38efe98ac9ddbf280",
"publicip_id": "615fa9cd5cff486c9de679b3ce63e601",
"state": "ACTIVE"
},
"subnet_id": "183c6c30df0c4fcbb16422aa2d64aa21"
}
]
}
1.85.3 - 1.0
get /v1/servers/{server_id}/interfaces/{port_id}
Description
Show Server Interface.
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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
| path | port_id
required | Port ID
Example : 91424c08-0b26-49fb-9808-ed042292ceef
| string | None |
Responses
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces/{port_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"interfaces": [
{
"fixed_ips": [
{
"ip_address": "192.169.3.2"
}
],
"mac_addr": "fa:16:3e:c0:71:2b",
"port_id": "f2b02fc5-a5fd-4b5f-b1a9-987f4c0d66cc",
"port_state": "ACTIVE",
"private_static_nat": {
"external_ip_address": "182.197.61.81",
"id": "224b80106e6f41b38efe98ac9ddbf280",
"private_nat_ip_id": "1f0cb5390c40483592ddc5a282f53496",
"state": "ACTIVE"
},
"static_nat": {
"external_ip_address": "182.197.61.81",
"id": "224b80106e6f41b38efe98ac9ddbf280",
"publicip_id": "615fa9cd5cff486c9de679b3ce63e601",
"state": "ACTIVE"
},
"subnet_id": "183c6c30df0c4fcbb16422aa2d64aa21"
}
]
}
1.86 - Show Server Ip
1.86.1 - 1.2
get /v1/servers/{server_id}/ips/{subnet_id}
Description
Show Server Ip.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
| path | subnet_id
required | Subnet ID
Example : 78b2ee3f074145c580ab6abac4821f97
| string | None |
Responses
Example HTTP request
Request path
/v1/servers/{server_id}/ips/{subnet_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"ip_addresses": [
{
"ip_address": "192.169.3.2",
"version": 4
}
],
"subnet_name": "subnetname"
}
1.86.2 - 1.1
get /v1/servers/{server_id}/ips/{subnet_id}
Description
Show Server Ip.
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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
| path | subnet_id
required | Subnet ID
Example : 78b2ee3f074145c580ab6abac4821f97
| string | None |
Responses
Example HTTP request
Request path
/v1/servers/{server_id}/ips/{subnet_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"ip_addresses": [
{
"ip_address": "192.169.3.2",
"version": 4
}
],
"subnet_name": "subnetname"
}
1.86.3 - 1.0
get /v1/servers/{server_id}/ips/{subnet_id}
Description
Show Server Ip.
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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
| path | subnet_id
required | Subnet ID
Example : 78b2ee3f074145c580ab6abac4821f97
| string | None |
Responses
Example HTTP request
Request path
/v1/servers/{server_id}/ips/{subnet_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"ip_addresses": [
{
"ip_address": "192.169.3.2",
"version": 4
}
],
"subnet_name": "subnetname"
}
1.87 - Show Server Quota Set
1.87.1 - 1.2
get /v1/quota-sets
Description
Show server quota Set.
State
ACTIVE (CURRENT)
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | ServerQuotaSet |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/quota-sets
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"cores": {
"in_use": 10,
"limit": 20,
"reserved": 0
},
"id": "fc7283354c6143a58629b59f4c3e16b2",
"instances": {
"in_use": 10,
"limit": 20,
"reserved": 0
},
"keypairs": {
"in_use": 10,
"limit": 20,
"reserved": 0
},
"metadata_items": {
"in_use": 10,
"limit": 20,
"reserved": 0
},
"ram": {
"in_use": 10,
"limit": 20,
"reserved": 0
},
"server_group_members": {
"in_use": 10,
"limit": 20,
"reserved": 0
},
"server_groups": {
"in_use": 10,
"limit": 20,
"reserved": 0
}
}
1.87.2 - 1.1
get /v1/quota-sets
Description
Show server quota Set.
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 |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | ServerQuotaSet |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/quota-sets
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"cores": {
"in_use": 10,
"limit": 20,
"reserved": 0
},
"id": "fc7283354c6143a58629b59f4c3e16b2",
"instances": {
"in_use": 10,
"limit": 20,
"reserved": 0
},
"keypairs": {
"in_use": 10,
"limit": 20,
"reserved": 0
},
"metadata_items": {
"in_use": 10,
"limit": 20,
"reserved": 0
},
"ram": {
"in_use": 10,
"limit": 20,
"reserved": 0
},
"server_group_members": {
"in_use": 10,
"limit": 20,
"reserved": 0
},
"server_groups": {
"in_use": 10,
"limit": 20,
"reserved": 0
}
}
1.87.3 - 1.0
get /v1/quota-sets
Description
Show server quota Set.
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 |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | ServerQuotaSet |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/quota-sets
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"cores": {
"in_use": 10,
"limit": 20,
"reserved": 0
},
"id": "fc7283354c6143a58629b59f4c3e16b2",
"instances": {
"in_use": 10,
"limit": 20,
"reserved": 0
},
"keypairs": {
"in_use": 10,
"limit": 20,
"reserved": 0
},
"metadata_items": {
"in_use": 10,
"limit": 20,
"reserved": 0
},
"ram": {
"in_use": 10,
"limit": 20,
"reserved": 0
},
"server_group_members": {
"in_use": 10,
"limit": 20,
"reserved": 0
},
"server_groups": {
"in_use": 10,
"limit": 20,
"reserved": 0
}
}
1.88 - Show Server Type
1.88.1 - 1.2
get /v1/server-types/{server_type_id}
Description
Show server type.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | server_type_id
required | Server type ID
Example : s1v1m2
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | ServerType |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/server-types/{server_type_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"description": "description",
"disk": 100,
"ephemeral": 0,
"extra_specs": "",
"id": "s1v1m2",
"name": "s1v1m2",
"ram": 2,
"swap": 0,
"vcpus": 1
}
1.88.2 - 1.1
get /v1/server-types/{server_type_id}
Description
Show server type.
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
| Type | Name | Description | Schema | Default |
|---|
| path | server_type_id
required | Server type ID
Example : s1v1m2
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | ServerType |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/server-types/{server_type_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"description": "description",
"disk": 100,
"ephemeral": 0,
"extra_specs": "",
"id": "s1v1m2",
"name": "s1v1m2",
"ram": 2,
"swap": 0,
"vcpus": 1
}
1.88.3 - 1.0
get /v1/server-types/{server_type_id}
Description
Show server type.
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
| Type | Name | Description | Schema | Default |
|---|
| path | server_type_id
required | Server type ID
Example : s1v1m2
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | ServerType |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/server-types/{server_type_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"description": "description",
"disk": 100,
"ephemeral": 0,
"extra_specs": "",
"id": "s1v1m2",
"name": "s1v1m2",
"ram": 2,
"swap": 0,
"vcpus": 1
}
1.89 - Show Server Volume
1.89.1 - 1.2
get /v1/servers/{server_id}/volumes/{volume_id}
Description
Show Server Volume.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
| path | volume_id
required | Volume ID
Example : 3f500f00-ed80-4566-a057-e31760226f9a
| string | None |
Responses
Example HTTP request
Request path
/v1/servers/{server_id}/volumes/{volume_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"delete_on_termination": false,
"device": "/dev/vda",
"id": "3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c",
"server_id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
1.89.2 - 1.1
get /v1/servers/{server_id}/volumes/{volume_id}
Description
Show Server Volume.
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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
| path | volume_id
required | Volume ID
Example : 3f500f00-ed80-4566-a057-e31760226f9a
| string | None |
Responses
Example HTTP request
Request path
/v1/servers/{server_id}/volumes/{volume_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"delete_on_termination": false,
"device": "/dev/vda",
"id": "3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c",
"server_id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
1.89.3 - 1.0
get /v1/servers/{server_id}/volumes/{volume_id}
Description
Show Server Volume.
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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
| path | volume_id
required | Volume ID
Example : 3f500f00-ed80-4566-a057-e31760226f9a
| string | None |
Responses
Example HTTP request
Request path
/v1/servers/{server_id}/volumes/{volume_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"delete_on_termination": false,
"device": "/dev/vda",
"id": "3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c",
"server_id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
1.90 - Show Virtual Server
1.90.1 - 1.2
get /v1/servers/{server_id}
Description
Show Virtual Server.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | ServerShowResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"addresses": [
{
"ip_addresses": [
{
"ip_address": "192.169.3.2",
"version": 4
}
],
"subnet_name": "subnetname"
}
],
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2026-04-14T15:06:26.964Z",
"created_by": "97e6b22c9a4143789ca522df7457a32f",
"disk_config": "MANUAL",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"is_marketplace": false,
"keypair_name": "keypairname",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"locked": false,
"metadata": "",
"modified_at": "2026-04-14T15:06:26.964Z",
"name": "servername",
"partition_number": 1,
"planned_compute_os_type": "windows",
"product_category": "compute",
"product_offering": "virtual_server",
"security_groups": [
{
"name": "securitygroup"
}
],
"server_group_id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"server_type": {
"disk": 100,
"ephemeral": 0,
"extra_specs": "",
"id": "s1v1m2",
"name": "s1v1m2",
"ram": 2,
"swap": 0,
"vcpus": 1
},
"state": "ACTIVE",
"volumes": [
{
"delete_on_termination": false,
"id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
],
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
1.90.2 - 1.1
get /v1/servers/{server_id}
Description
Show 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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | ServerShowResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"addresses": [
{
"ip_addresses": [
{
"ip_address": "192.169.3.2",
"version": 4
}
],
"subnet_name": "subnetname"
}
],
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2026-04-14T15:06:24.507Z",
"created_by": "97e6b22c9a4143789ca522df7457a32f",
"disk_config": "MANUAL",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"is_marketplace": false,
"keypair_name": "keypairname",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"locked": false,
"metadata": "",
"modified_at": "2026-04-14T15:06:24.507Z",
"name": "servername",
"partition_number": 1,
"planned_compute_os_type": "windows",
"product_category": "compute",
"product_offering": "virtual_server",
"security_groups": [
{
"name": "securitygroup"
}
],
"server_group_id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"server_type": {
"disk": 100,
"ephemeral": 0,
"extra_specs": "",
"id": "s1v1m2",
"name": "s1v1m2",
"ram": 2,
"swap": 0,
"vcpus": 1
},
"state": "ACTIVE",
"volumes": [
{
"delete_on_termination": false,
"id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
],
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
1.90.3 - 1.0
get /v1/servers/{server_id}
Description
Show 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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | ServerShowResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"addresses": [
{
"ip_addresses": [
{
"ip_address": "192.169.3.2",
"version": 4
}
],
"subnet_name": "subnetname"
}
],
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2026-04-14T15:06:21.971Z",
"created_by": "97e6b22c9a4143789ca522df7457a32f",
"disk_config": "MANUAL",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"is_marketplace": false,
"keypair_name": "keypairname",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"locked": false,
"metadata": "",
"modified_at": "2026-04-14T15:06:21.971Z",
"name": "servername",
"partition_number": 1,
"planned_compute_os_type": "windows",
"product_category": "compute",
"product_offering": "virtual_server",
"security_groups": [
{
"name": "securitygroup"
}
],
"server_group_id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"server_type": {
"disk": 100,
"ephemeral": 0,
"extra_specs": "",
"id": "s1v1m2",
"name": "s1v1m2",
"ram": 2,
"swap": 0,
"vcpus": 1
},
"state": "ACTIVE",
"volumes": [
{
"delete_on_termination": false,
"id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
],
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
1.91 - Show Virtual Server Console Log
1.91.1 - 1.2
get /v1/servers/{server_id}/console-log
Description
Show Virtual Server Console Log.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
| query | line_size
optional | Number of log lines to get
Example : 1
| any of [integer, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | ServerConsoleLogResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/console-log
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"output": "FAKE CONSOLE OUTPUT"
}
1.91.2 - 1.1
get /v1/servers/{server_id}/console-log
Description
Show Virtual Server Console Log.
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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
| query | line_size
optional | Number of log lines to get
Example : 1
| any of [integer, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | ServerConsoleLogResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/console-log
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"output": "FAKE CONSOLE OUTPUT"
}
1.91.3 - 1.0
get /v1/servers/{server_id}/console-log
Description
Show Virtual Server Console Log.
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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
| query | line_size
optional | Number of log lines to get
Example : 1
| any of [integer, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | ServerConsoleLogResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/console-log
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"output": "FAKE CONSOLE OUTPUT"
}
1.92 - Show Virtual Server Password
1.92.1 - 1.2
post /v1/servers/{server_id}/password
Description
Show Virtual Server Password.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
| body | body
required |
| ServerPasswordRequest | |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | ServerPasswordResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/password
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"private_key": "-----BEGIN RSA PRIVATE KEY-----\nfakeKey\n-----END RSA PRIVATE KEY-----"
}
Example HTTP response
Response 200
{
"password": "password"
}
1.92.2 - 1.1
post /v1/servers/{server_id}/password
Description
Show Virtual Server Password.
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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
| body | body
required |
| ServerPasswordRequest | |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | ServerPasswordResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/password
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"private_key": "-----BEGIN RSA PRIVATE KEY-----\nfakeKey\n-----END RSA PRIVATE KEY-----"
}
Example HTTP response
Response 200
{
"password": "password"
}
1.92.3 - 1.0
post /v1/servers/{server_id}/password
Description
Show Virtual Server Password.
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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
| body | body
required |
| ServerPasswordRequest | |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | ServerPasswordResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/password
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"private_key": "-----BEGIN RSA PRIVATE KEY-----\nfakeKey\n-----END RSA PRIVATE KEY-----"
}
Example HTTP response
Response 200
{
"password": "password"
}
1.93 - Show Volume Quota Set
1.93.1 - 1.2
get /v1/volumes/quota-sets
Description
Show volume quota set.
State
ACTIVE (CURRENT)
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | VolumeQuotaSet |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/volumes/quota-sets
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"id": "fc7283354c6143a58629b59f4c3e16b2",
"per_volume_size": {
"in_use": 10,
"limit": "",
"reserved": 0
},
"snapshots": {
"in_use": 10,
"limit": "",
"reserved": 0
},
"usages": {
"in_use": 10,
"limit": "",
"reserved": 0
},
"volumes": {
"in_use": 10,
"limit": "",
"reserved": 0
}
}
1.93.2 - 1.1
get /v1/volumes/quota-sets
Description
Show volume quota set.
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 |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | VolumeQuotaSet |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/volumes/quota-sets
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"id": "fc7283354c6143a58629b59f4c3e16b2",
"per_volume_size": {
"in_use": 10,
"limit": "",
"reserved": 0
},
"snapshots": {
"in_use": 10,
"limit": "",
"reserved": 0
},
"usages": {
"in_use": 10,
"limit": "",
"reserved": 0
},
"volumes": {
"in_use": 10,
"limit": "",
"reserved": 0
}
}
1.93.3 - 1.0
get /v1/volumes/quota-sets
Description
Show volume quota set.
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 |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | VolumeQuotaSet |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/volumes/quota-sets
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"id": "fc7283354c6143a58629b59f4c3e16b2",
"per_volume_size": {
"in_use": 10,
"limit": "",
"reserved": 0
},
"snapshots": {
"in_use": 10,
"limit": "",
"reserved": 0
},
"usages": {
"in_use": 10,
"limit": "",
"reserved": 0
},
"volumes": {
"in_use": 10,
"limit": "",
"reserved": 0
}
}
1.94 - Show volume transfer detail
1.94.1 - 1.2
get /v1/volume-transfer/{transfer_id}
Description
Show volume transfer detail.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | transfer_id
required | Volume Transfer ID
Example : 1ac231be-823b-4a4d-8ff0-aac503a7118a
| string | None |
Responses
Example HTTP request
Request path
/v1/volume-transfer/{transfer_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"created_at": "2025-07-22T09:00:00Z",
"id": "1ac231be-823b-4a4d-8ff0-aac503a7118a",
"name": "volume01",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
1.94.2 - 1.1
get /v1/volume-transfer/{transfer_id}
Description
Show volume transfer detail.
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
| Type | Name | Description | Schema | Default |
|---|
| path | transfer_id
required | Volume Transfer ID
Example : 1ac231be-823b-4a4d-8ff0-aac503a7118a
| string | None |
Responses
Example HTTP request
Request path
/v1/volume-transfer/{transfer_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"created_at": "2025-07-22T09:00:00Z",
"id": "1ac231be-823b-4a4d-8ff0-aac503a7118a",
"name": "volume01",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
1.94.3 - 1.0
get /v1/volume-transfer/{transfer_id}
Description
Show volume transfer detail.
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
| Type | Name | Description | Schema | Default |
|---|
| path | transfer_id
required | Volume Transfer ID
Example : 1ac231be-823b-4a4d-8ff0-aac503a7118a
| string | None |
Responses
Example HTTP request
Request path
/v1/volume-transfer/{transfer_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"created_at": "2025-07-22T09:00:00Z",
"id": "1ac231be-823b-4a4d-8ff0-aac503a7118a",
"name": "volume01",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
1.95 - Show Volume type’s details
1.95.1 - 1.2
get /v1/volume-types/{volume_type_id}
Description
Show a Volume type’s details.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_type_id
required | Volume type ID
Example : c643ac35-3aec-43e6-b97a-3d6f666c5207
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | VolumeTypeDetailResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 500 | Internal Server Error | None |
Example HTTP request
Request path
/v1/volume-types/{volume_type_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"description": "Volume type description",
"extra_specs": {
"multiattach": "<is> True"
},
"id": "c643ac35-3aec-43e6-b97a-3d6f666c5207",
"name": "SSD"
}
1.95.2 - 1.1
get /v1/volume-types/{volume_type_id}
Description
Show a Volume type’s details.
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
| Type | Name | Description | Schema | Default |
|---|
| path | volume_type_id
required | Volume type ID
Example : c643ac35-3aec-43e6-b97a-3d6f666c5207
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | VolumeTypeDetailResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 500 | Internal Server Error | None |
Example HTTP request
Request path
/v1/volume-types/{volume_type_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"description": "Volume type description",
"extra_specs": {
"multiattach": "<is> True"
},
"id": "c643ac35-3aec-43e6-b97a-3d6f666c5207",
"name": "SSD"
}
1.95.3 - 1.0
get /v1/volume-types/{volume_type_id}
Description
Show a Volume type’s details.
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
| Type | Name | Description | Schema | Default |
|---|
| path | volume_type_id
required | Volume type ID
Example : c643ac35-3aec-43e6-b97a-3d6f666c5207
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | VolumeTypeDetailResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 500 | Internal Server Error | None |
Example HTTP request
Request path
/v1/volume-types/{volume_type_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"description": "Volume type description",
"extra_specs": {
"multiattach": "<is> True"
},
"id": "c643ac35-3aec-43e6-b97a-3d6f666c5207",
"name": "SSD"
}
1.96 - Show Volume's details
1.96.1 - 1.2
get /v1/volumes/{volume_id}
Description
Show a Volume’s details.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume ID
Example : 3f500f00-ed80-4566-a057-e31760226f9a
| string | None |
Responses
Example HTTP request
Request path
/v1/volumes/{volume_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"bootable": false,
"created_at": "2026-04-14T15:06:28.049Z",
"encrypted": true,
"id": "3f500f00-ed80-4566-a057-e31760226f9a",
"max_iops": 10000,
"max_throughput": 500,
"modified_at": "2025-07-26T12:00:00Z",
"multiattach": false,
"name": "volume01",
"servers": [
{
"attached_at": "2026-04-14T15:06:28.049Z",
"device": "/dev/vda",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
}
],
"size": 104,
"snapshot_id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"state": "available",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_image_metadata": {
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"disk_format": "qcow2",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"min_disk": 100,
"min_ram": 0,
"os_distro": "alma",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"signature_verified": false,
"size": 2429747200
},
"volume_type": "SSD",
"volume_type_id": "c643ac35-3aec-43e6-b97a-3d6f666c5207"
}
1.96.2 - 1.1
get /v1/volumes/{volume_id}
Description
Show a Volume’s details.
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
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume ID
Example : 3f500f00-ed80-4566-a057-e31760226f9a
| string | None |
Responses
Example HTTP request
Request path
/v1/volumes/{volume_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"bootable": false,
"created_at": "2026-04-14T15:06:25.551Z",
"encrypted": true,
"id": "3f500f00-ed80-4566-a057-e31760226f9a",
"modified_at": "2025-07-26T12:00:00Z",
"multiattach": false,
"name": "volume01",
"servers": [
{
"attached_at": "2026-04-14T15:06:25.551Z",
"device": "/dev/vda",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
}
],
"size": 104,
"snapshot_id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"state": "available",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_image_metadata": {
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"disk_format": "qcow2",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"min_disk": 100,
"min_ram": 0,
"os_distro": "alma",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"signature_verified": false,
"size": 2429747200
},
"volume_type": "SSD",
"volume_type_id": "c643ac35-3aec-43e6-b97a-3d6f666c5207"
}
1.96.3 - 1.0
get /v1/volumes/{volume_id}
Description
Show a Volume’s details.
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
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume ID
Example : 3f500f00-ed80-4566-a057-e31760226f9a
| string | None |
Responses
Example HTTP request
Request path
/v1/volumes/{volume_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"bootable": false,
"created_at": "2026-04-14T15:06:23.053Z",
"encrypted": true,
"id": "3f500f00-ed80-4566-a057-e31760226f9a",
"modified_at": "2025-07-26T12:00:00Z",
"multiattach": false,
"name": "volume01",
"servers": [
{
"attached_at": "2026-04-14T15:06:23.053Z",
"device": "/dev/vda",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
}
],
"size": 104,
"snapshot_id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"state": "available",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_image_metadata": {
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"disk_format": "qcow2",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"min_disk": 100,
"min_ram": 0,
"os_distro": "alma",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"signature_verified": false,
"size": 2429747200
},
"volume_type": "SSD",
"volume_type_id": "c643ac35-3aec-43e6-b97a-3d6f666c5207"
}
1.97 - Start Virtual Server
1.97.1 - 1.2
post /v1/servers/{server_id}/start
Description
Start Virtual Server.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/start
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 202
1.97.2 - 1.1
post /v1/servers/{server_id}/start
Description
Start 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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/start
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 202
1.97.3 - 1.0
post /v1/servers/{server_id}/start
Description
Start 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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/start
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 202
1.98 - Stop Virtual Server
1.98.1 - 1.2
post /v1/servers/{server_id}/stop
Description
Stop Virtual Server.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/stop
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 202
1.98.2 - 1.1
post /v1/servers/{server_id}/stop
Description
Stop 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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/stop
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 202
1.98.3 - 1.0
post /v1/servers/{server_id}/stop
Description
Stop 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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/stop
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 202
1.99 - Unlock Virtual Server
1.99.1 - 1.2
post /v1/servers/{server_id}/unlock
Description
Unlock Virtual Server.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/unlock
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 202
1.99.2 - 1.1
post /v1/servers/{server_id}/unlock
Description
Unlock 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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/unlock
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 202
1.99.3 - 1.0
post /v1/servers/{server_id}/unlock
Description
Unlock 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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/unlock
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 202
1.100 - Update a snapshot
1.100.1 - 1.2
put /v1/snapshots/{snapshot_id}
Description
Update a snapshot.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | snapshot_id
required | Snapshot ID
Example : cceed636-1f1e-4bb0-b85c-4e5b9e0bf790
| string | None |
| body | body
required |
| SnapshotUpdateRequest | |
Responses
Example HTTP request
Request path
/v1/snapshots/{snapshot_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"description": "description",
"name": "snapshot-1"
}
Example HTTP response
Response 200
{
"created_at": "2025-07-22T09:00:00Z",
"description": "description",
"id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"metadata": "Metadata",
"name": "snapshot-1",
"size": 104,
"status": "available",
"updated_at": "2025-07-26T12:00:00Z",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
1.100.2 - 1.1
put /v1/snapshots/{snapshot_id}
Description
Update a snapshot.
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
| Type | Name | Description | Schema | Default |
|---|
| path | snapshot_id
required | Snapshot ID
Example : cceed636-1f1e-4bb0-b85c-4e5b9e0bf790
| string | None |
| body | body
required |
| SnapshotUpdateRequest | |
Responses
Example HTTP request
Request path
/v1/snapshots/{snapshot_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"description": "description",
"name": "snapshot-1"
}
Example HTTP response
Response 200
{
"created_at": "2025-07-22T09:00:00Z",
"description": "description",
"id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"metadata": "Metadata",
"name": "snapshot-1",
"size": 104,
"status": "available",
"updated_at": "2025-07-26T12:00:00Z",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
1.100.3 - 1.0
put /v1/snapshots/{snapshot_id}
Description
Update a snapshot.
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
| Type | Name | Description | Schema | Default |
|---|
| path | snapshot_id
required | Snapshot ID
Example : cceed636-1f1e-4bb0-b85c-4e5b9e0bf790
| string | None |
| body | body
required |
| SnapshotUpdateRequest | |
Responses
Example HTTP request
Request path
/v1/snapshots/{snapshot_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"description": "description",
"name": "snapshot-1"
}
Example HTTP response
Response 200
{
"created_at": "2025-07-22T09:00:00Z",
"description": "description",
"id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"metadata": "Metadata",
"name": "snapshot-1",
"size": 104,
"status": "available",
"updated_at": "2025-07-26T12:00:00Z",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
1.101 - Update Auto-Scaling Group
1.101.1 - 1.2
put /v1/auto-scaling-groups/{auto_scaling_group_id}
Description
Update Auto-Scaling Group.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | None |
| body | body
required |
| AutoScalingGroupSetRequestV1Dot2 | |
Responses
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"desired_server_count_editable": true,
"drain_enabled": true,
"drain_timeout": 300,
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"security_group_ids": [
"c09c3f05-03d9-443f-b27a-40e0f973c75f"
],
"state_check_delay_time": 300,
"use_lb_state_check": true
}
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"desired_server_count": 1,
"desired_server_count_editable": true,
"drain_enabled": true,
"drain_timeout": 300,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"launch_configuration_name": "launch-configuration-name",
"lb_server_groups": [],
"max_server_count": 2,
"min_server_count": 1,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "auto-scaling-group-name",
"security_group_ids": [
"c09c3f05-03d9-443f-b27a-40e0f973c75f"
],
"server_name_prefix": "server-name-prefix",
"state": "IN_SERVICE",
"state_check_delay_time": 300,
"subnet_ids": [],
"total_server_count": 1,
"use_lb_state_check": true,
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
1.101.2 - 1.1
put /v1/auto-scaling-groups/{auto_scaling_group_id}
Description
Update Auto-Scaling Group.
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
| Type | Name | Description | Schema | Default |
|---|
| path | auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | None |
| body | body
required |
| AutoScalingGroupSetRequest | |
Responses
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"desired_server_count_editable": true,
"drain_enabled": true,
"drain_timeout": 300,
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"security_group_ids": [
"c09c3f05-03d9-443f-b27a-40e0f973c75f"
]
}
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"desired_server_count": 1,
"desired_server_count_editable": true,
"drain_enabled": true,
"drain_timeout": 300,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"launch_configuration_name": "launch-configuration-name",
"lb_server_groups": [],
"max_server_count": 2,
"min_server_count": 1,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "auto-scaling-group-name",
"security_group_ids": [
"c09c3f05-03d9-443f-b27a-40e0f973c75f"
],
"server_name_prefix": "server-name-prefix",
"state": "IN_SERVICE",
"subnet_ids": [],
"total_server_count": 1,
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
1.101.3 - 1.0
put /v1/auto-scaling-groups/{auto_scaling_group_id}
Description
Update Auto-Scaling Group.
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
| Type | Name | Description | Schema | Default |
|---|
| path | auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | None |
| body | body
required |
| AutoScalingGroupSetRequest | |
Responses
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"desired_server_count_editable": true,
"drain_enabled": true,
"drain_timeout": 300,
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"security_group_ids": [
"c09c3f05-03d9-443f-b27a-40e0f973c75f"
]
}
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"desired_server_count": 1,
"desired_server_count_editable": true,
"drain_enabled": true,
"drain_timeout": 300,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"launch_configuration_name": "launch-configuration-name",
"lb_server_groups": [],
"max_server_count": 2,
"min_server_count": 1,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "auto-scaling-group-name",
"security_group_ids": [
"c09c3f05-03d9-443f-b27a-40e0f973c75f"
],
"server_name_prefix": "server-name-prefix",
"state": "IN_SERVICE",
"subnet_ids": [],
"total_server_count": 1,
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
1.102 - Update Auto-Scaling Group LB Server Groups
1.102.1 - 1.2
put /v1/auto-scaling-groups/{auto_scaling_group_id}/lb-server-groups
Description
Update Auto-Scaling Group LB Server Groups.
State
ACTIVE (CURRENT)
Parameters
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/lb-server-groups
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"lb_server_groups": [
{
"id": "d06e87d3-ca9a-461b-8e88-077a542a7335",
"port": 8080
}
]
}
Example HTTP response
Response 202
1.102.2 - 1.1
put /v1/auto-scaling-groups/{auto_scaling_group_id}/lb-server-groups
Description
Update Auto-Scaling Group LB Server Groups.
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
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/lb-server-groups
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"lb_server_groups": [
{
"id": "d06e87d3-ca9a-461b-8e88-077a542a7335",
"port": 8080
}
]
}
Example HTTP response
Response 202
1.102.3 - 1.0
put /v1/auto-scaling-groups/{auto_scaling_group_id}/lb-server-groups
Description
Update Auto-Scaling Group LB Server Groups.
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
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/lb-server-groups
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"lb_server_groups": [
{
"id": "d06e87d3-ca9a-461b-8e88-077a542a7335",
"port": 8080
}
]
}
Example HTTP response
Response 202
1.103 - Update Auto-Scaling Group Notification
1.103.1 - 1.2
put /v1/auto-scaling-groups/{auto_scaling_group_id}/notifications/{notification_id}
Description
Update Auto-Scaling Group notification.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | None |
| path | notification_id
required | Auto-Scaling Group notification ID
Example : fa7fd191410744cd810a290c0b4d22b9
| string | None |
| body | body
required |
| AutoScalingGroupNotificationUpdateRequest | |
Responses
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/notifications/{notification_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"notification_events": [
"SCALE_OUT",
"SCALE_OUT_FAIL"
],
"notification_state": "ACTIVE"
}
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"notification_events": [
"SCALE_OUT",
"SCALE_OUT_FAIL"
],
"notification_state": "ACTIVE",
"user_email": "scpuser@samsung.com",
"user_id": "570907805e5447be84b618450ef52o0t",
"user_name": "scpuser"
}
1.103.2 - 1.1
put /v1/auto-scaling-groups/{auto_scaling_group_id}/notifications/{notification_id}
Description
Update Auto-Scaling Group notification.
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
| Type | Name | Description | Schema | Default |
|---|
| path | auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | None |
| path | notification_id
required | Auto-Scaling Group notification ID
Example : fa7fd191410744cd810a290c0b4d22b9
| string | None |
| body | body
required |
| AutoScalingGroupNotificationUpdateRequest | |
Responses
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/notifications/{notification_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"notification_events": [
"SCALE_OUT",
"SCALE_OUT_FAIL"
],
"notification_state": "ACTIVE"
}
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"notification_events": [
"SCALE_OUT",
"SCALE_OUT_FAIL"
],
"notification_state": "ACTIVE",
"user_email": "scpuser@samsung.com",
"user_id": "570907805e5447be84b618450ef52o0t",
"user_name": "scpuser"
}
1.103.3 - 1.0
put /v1/auto-scaling-groups/{auto_scaling_group_id}/notifications/{notification_id}
Description
Update Auto-Scaling Group notification.
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
| Type | Name | Description | Schema | Default |
|---|
| path | auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | None |
| path | notification_id
required | Auto-Scaling Group notification ID
Example : fa7fd191410744cd810a290c0b4d22b9
| string | None |
| body | body
required |
| AutoScalingGroupNotificationUpdateRequest | |
Responses
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/notifications/{notification_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"notification_events": [
"SCALE_OUT",
"SCALE_OUT_FAIL"
],
"notification_state": "ACTIVE"
}
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"notification_events": [
"SCALE_OUT",
"SCALE_OUT_FAIL"
],
"notification_state": "ACTIVE",
"user_email": "scpuser@samsung.com",
"user_id": "570907805e5447be84b618450ef52o0t",
"user_name": "scpuser"
}
1.104 - Update Auto-Scaling Group Policy
1.104.1 - 1.2
put /v1/auto-scaling-groups/{auto_scaling_group_id}/policies/{policy_id}
Description
Update Auto-Scaling Group policy.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | None |
| path | policy_id
required | Policy ID
Example : 0761d76085f54363bab07909baf69841
| string | None |
| body | body
required |
| AutoScalingGroupPolicyUpdateRequestV1Dot2 | |
Responses
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/policies/{policy_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"comparison_operator": "ge",
"cooldown_seconds": 300,
"evaluation_minutes": 5,
"metric_method": "AVG",
"metric_type": "CPU",
"scale_method": "AMOUNT",
"scale_type": "SCALE_OUT",
"scale_value": 10,
"state": "ACTIVE",
"threshold": 60
}
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"comparison_operator": "ge",
"cooldown_seconds": 300,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"evaluation_minutes": 5,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"metric_method": "AVG",
"metric_type": "CPU",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "policy-name",
"scale_method": "AMOUNT",
"scale_type": "SCALE_OUT",
"scale_value": 10,
"state": "ACTIVE",
"threshold": 60,
"threshold_unit": "%"
}
1.104.2 - 1.1
put /v1/auto-scaling-groups/{auto_scaling_group_id}/policies/{policy_id}
Description
Update Auto-Scaling Group policy.
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
| Type | Name | Description | Schema | Default |
|---|
| path | auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | None |
| path | policy_id
required | Policy ID
Example : 0761d76085f54363bab07909baf69841
| string | None |
| body | body
required |
| AutoScalingGroupPolicyUpdateRequest | |
Responses
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/policies/{policy_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"comparison_operator": "ge",
"cooldown_seconds": 300,
"evaluation_minutes": 5,
"metric_method": "AVG",
"metric_type": "CPU",
"name": "policy-name",
"scale_method": "AMOUNT",
"scale_type": "SCALE_OUT",
"scale_value": 10,
"state": "ACTIVE",
"threshold": 60
}
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"comparison_operator": "ge",
"cooldown_seconds": 300,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"evaluation_minutes": 5,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"metric_method": "AVG",
"metric_type": "CPU",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "policy-name",
"scale_method": "AMOUNT",
"scale_type": "SCALE_OUT",
"scale_value": 10,
"state": "ACTIVE",
"threshold": 60,
"threshold_unit": "%"
}
1.104.3 - 1.0
put /v1/auto-scaling-groups/{auto_scaling_group_id}/policies/{policy_id}
Description
Update Auto-Scaling Group policy.
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
| Type | Name | Description | Schema | Default |
|---|
| path | auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | None |
| path | policy_id
required | Policy ID
Example : 0761d76085f54363bab07909baf69841
| string | None |
| body | body
required |
| AutoScalingGroupPolicyUpdateRequest | |
Responses
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/policies/{policy_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"comparison_operator": "ge",
"cooldown_seconds": 300,
"evaluation_minutes": 5,
"metric_method": "AVG",
"metric_type": "CPU",
"name": "policy-name",
"scale_method": "AMOUNT",
"scale_type": "SCALE_OUT",
"scale_value": 10,
"state": "ACTIVE",
"threshold": 60
}
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"comparison_operator": "ge",
"cooldown_seconds": 300,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"evaluation_minutes": 5,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"metric_method": "AVG",
"metric_type": "CPU",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "policy-name",
"scale_method": "AMOUNT",
"scale_type": "SCALE_OUT",
"scale_value": 10,
"state": "ACTIVE",
"threshold": 60,
"threshold_unit": "%"
}
1.105 - Update Auto-Scaling Group Schedule
1.105.1 - 1.2
put /v1/auto-scaling-groups/{auto_scaling_group_id}/schedules/{schedule_id}
Description
Update Auto-Scaling Group schedule.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | None |
| path | schedule_id
required | Schedule ID
Example : 43d4841abd404220af5f0904037aba71
| string | None |
| body | body
required |
| AutoScalingGroupScheduleUpdateRequest | |
Responses
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/schedules/{schedule_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"day_of_month": "-1,1",
"day_of_week": "SU,SA",
"description": "description",
"desired_server_count": 1,
"end_date": "2025-01-01",
"frequency": "WEEKLY",
"hour": 9,
"max_server_count": 2,
"min_server_count": 1,
"minute": 0,
"name": "schedulename",
"start_date": "2024-01-01",
"state": "ACTIVE",
"timezone": "Asia/Seoul"
}
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"day_of_month": "-1,1",
"day_of_week": "SU,SA",
"description": "description",
"desired_server_count": 1,
"end_date": "2025-01-01",
"frequency": "WEEKLY",
"hour": 9,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"max_server_count": 2,
"min_server_count": 1,
"minute": 0,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "schedulename",
"start_date": "2024-01-01",
"state": "ACTIVE",
"timezone": "Asia/Seoul"
}
1.105.2 - 1.1
put /v1/auto-scaling-groups/{auto_scaling_group_id}/schedules/{schedule_id}
Description
Update Auto-Scaling Group schedule.
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
| Type | Name | Description | Schema | Default |
|---|
| path | auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | None |
| path | schedule_id
required | Schedule ID
Example : 43d4841abd404220af5f0904037aba71
| string | None |
| body | body
required |
| AutoScalingGroupScheduleUpdateRequest | |
Responses
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/schedules/{schedule_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"day_of_month": "-1,1",
"day_of_week": "SU,SA",
"description": "description",
"desired_server_count": 1,
"end_date": "2025-01-01",
"frequency": "WEEKLY",
"hour": 9,
"max_server_count": 2,
"min_server_count": 1,
"minute": 0,
"name": "schedulename",
"start_date": "2024-01-01",
"state": "ACTIVE",
"timezone": "Asia/Seoul"
}
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"day_of_month": "-1,1",
"day_of_week": "SU,SA",
"description": "description",
"desired_server_count": 1,
"end_date": "2025-01-01",
"frequency": "WEEKLY",
"hour": 9,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"max_server_count": 2,
"min_server_count": 1,
"minute": 0,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "schedulename",
"start_date": "2024-01-01",
"state": "ACTIVE",
"timezone": "Asia/Seoul"
}
1.105.3 - 1.0
put /v1/auto-scaling-groups/{auto_scaling_group_id}/schedules/{schedule_id}
Description
Update Auto-Scaling Group schedule.
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
| Type | Name | Description | Schema | Default |
|---|
| path | auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | None |
| path | schedule_id
required | Schedule ID
Example : 43d4841abd404220af5f0904037aba71
| string | None |
| body | body
required |
| AutoScalingGroupScheduleUpdateRequest | |
Responses
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/schedules/{schedule_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"day_of_month": "-1,1",
"day_of_week": "SU,SA",
"description": "description",
"desired_server_count": 1,
"end_date": "2025-01-01",
"frequency": "WEEKLY",
"hour": 9,
"max_server_count": 2,
"min_server_count": 1,
"minute": 0,
"name": "schedulename",
"start_date": "2024-01-01",
"state": "ACTIVE",
"timezone": "Asia/Seoul"
}
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"day_of_month": "-1,1",
"day_of_week": "SU,SA",
"description": "description",
"desired_server_count": 1,
"end_date": "2025-01-01",
"frequency": "WEEKLY",
"hour": 9,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"max_server_count": 2,
"min_server_count": 1,
"minute": 0,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "schedulename",
"start_date": "2024-01-01",
"state": "ACTIVE",
"timezone": "Asia/Seoul"
}
1.106 - Update Auto-Scaling Group server count
1.106.1 - 1.2
put /v1/auto-scaling-groups/{auto_scaling_group_id}/server-count
Description
Update Auto-Scaling Group server count.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | None |
| body | body
required |
| AutoScalingGroupSetServerCountRequest | |
Responses
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/server-count
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"desired_server_count": 1,
"max_server_count": 2,
"min_server_count": 1
}
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"desired_server_count": 1,
"desired_server_count_editable": true,
"drain_enabled": true,
"drain_timeout": 300,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"launch_configuration_name": "launch-configuration-name",
"lb_server_groups": [],
"max_server_count": 2,
"min_server_count": 1,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "auto-scaling-group-name",
"security_group_ids": [
"c09c3f05-03d9-443f-b27a-40e0f973c75f"
],
"server_name_prefix": "server-name-prefix",
"state": "IN_SERVICE",
"state_check_delay_time": 300,
"subnet_ids": [],
"total_server_count": 1,
"use_lb_state_check": true,
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
1.106.2 - 1.1
put /v1/auto-scaling-groups/{auto_scaling_group_id}/server-count
Description
Update Auto-Scaling Group server count.
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
| Type | Name | Description | Schema | Default |
|---|
| path | auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | None |
| body | body
required |
| AutoScalingGroupSetServerCountRequest | |
Responses
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/server-count
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"desired_server_count": 1,
"max_server_count": 2,
"min_server_count": 1
}
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"desired_server_count": 1,
"desired_server_count_editable": true,
"drain_enabled": true,
"drain_timeout": 300,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"launch_configuration_name": "launch-configuration-name",
"lb_server_groups": [],
"max_server_count": 2,
"min_server_count": 1,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "auto-scaling-group-name",
"security_group_ids": [
"c09c3f05-03d9-443f-b27a-40e0f973c75f"
],
"server_name_prefix": "server-name-prefix",
"state": "IN_SERVICE",
"subnet_ids": [],
"total_server_count": 1,
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
1.106.3 - 1.0
put /v1/auto-scaling-groups/{auto_scaling_group_id}/server-count
Description
Update Auto-Scaling Group server count.
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
| Type | Name | Description | Schema | Default |
|---|
| path | auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | None |
| body | body
required |
| AutoScalingGroupSetServerCountRequest | |
Responses
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/server-count
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"desired_server_count": 1,
"max_server_count": 2,
"min_server_count": 1
}
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"desired_server_count": 1,
"desired_server_count_editable": true,
"drain_enabled": true,
"drain_timeout": 300,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"launch_configuration_name": "launch-configuration-name",
"lb_server_groups": [],
"max_server_count": 2,
"min_server_count": 1,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "auto-scaling-group-name",
"security_group_ids": [
"c09c3f05-03d9-443f-b27a-40e0f973c75f"
],
"server_name_prefix": "server-name-prefix",
"state": "IN_SERVICE",
"subnet_ids": [],
"total_server_count": 1,
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
1.107 - Update Image
1.107.1 - 1.2
put /v1/images/{image_id}
Description
Update Image.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | image_id
required | Image ID
Example : 70a599e0-31e7-49b7-b260-868f441e862b
| string | None |
| body | body
required |
| ImageSetRequest | |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | ImageShowResponseV1Dot2 |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/images/{image_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"min_disk": 100,
"min_ram": 0,
"protected": false,
"visibility": "private"
}
Example HTTP response
Response 200
{
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"created_at": "2025-07-22T09:00:00Z",
"disk_format": "qcow2",
"file": "/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file",
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"min_disk": 100,
"min_ram": 0,
"name": "imagename",
"os_distro": "alma",
"os_hash_algo": "sha512",
"os_hash_value": "c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99",
"os_hidden": false,
"owner": "a8f10467abfc4b87b64614ab36eb9ae4",
"owner_account_name": "AccountName",
"owner_user_name": "user@samsung.com",
"protected": false,
"root_device_name": "/dev/vda",
"scp_gpu_driver": "535.183.06",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"scp_os_build_version": "20250101",
"scp_os_version": "8.8",
"size": 2429747200,
"status": "active",
"updated_at": "2025-07-26T12:00:00Z",
"url": "https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2",
"virtual_size": 17179869184,
"visibility": "private",
"volumes": "[{\"tag\": null, \"volume_id\": null, \"encryption_options\": null, \"encryption_secret_uuid\": null, \"encryption_format\": null, \"device_name\": \"/dev/vda\", \"disk_bus\": \"virtio\", \"volume_type\": null, \"encrypted\": null, \"image_id\": null, \"device_type\": \"disk\", \"source_type\": \"snapshot\", \"delete_on_termination\": false, \"volume_size\": 104, \"guest_format\": null, \"boot_index\": 0, \"destination_type\": \"volume\", \"snapshot_id\": \"abde9e38-2ed5-4ecd-b23c-b0120e30690e\", \"no_device\": null}]"
}
1.107.2 - 1.1
put /v1/images/{image_id}
Description
Update Image.
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
| Type | Name | Description | Schema | Default |
|---|
| path | image_id
required | Image ID
Example : 70a599e0-31e7-49b7-b260-868f441e862b
| string | None |
| body | body
required |
| ImageSetRequest | |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | ImageShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/images/{image_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"min_disk": 100,
"min_ram": 0,
"protected": false,
"visibility": "private"
}
Example HTTP response
Response 200
{
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"created_at": "2025-07-22T09:00:00Z",
"disk_format": "qcow2",
"file": "/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file",
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"min_disk": 100,
"min_ram": 0,
"name": "imagename",
"os_distro": "alma",
"os_hash_algo": "sha512",
"os_hash_value": "c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99",
"os_hidden": false,
"owner": "a8f10467abfc4b87b64614ab36eb9ae4",
"owner_account_name": "AccountName",
"owner_user_name": "user@samsung.com",
"protected": false,
"root_device_name": "/dev/vda",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"scp_os_build_version": "20250101",
"scp_os_version": "8.8",
"size": 2429747200,
"status": "active",
"updated_at": "2025-07-26T12:00:00Z",
"url": "https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2",
"virtual_size": 17179869184,
"visibility": "private",
"volumes": "[{\"tag\": null, \"volume_id\": null, \"encryption_options\": null, \"encryption_secret_uuid\": null, \"encryption_format\": null, \"device_name\": \"/dev/vda\", \"disk_bus\": \"virtio\", \"volume_type\": null, \"encrypted\": null, \"image_id\": null, \"device_type\": \"disk\", \"source_type\": \"snapshot\", \"delete_on_termination\": false, \"volume_size\": 104, \"guest_format\": null, \"boot_index\": 0, \"destination_type\": \"volume\", \"snapshot_id\": \"abde9e38-2ed5-4ecd-b23c-b0120e30690e\", \"no_device\": null}]"
}
1.107.3 - 1.0
put /v1/images/{image_id}
Description
Update Image.
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
| Type | Name | Description | Schema | Default |
|---|
| path | image_id
required | Image ID
Example : 70a599e0-31e7-49b7-b260-868f441e862b
| string | None |
| body | body
required |
| ImageSetRequest | |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | ImageShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/images/{image_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"min_disk": 100,
"min_ram": 0,
"protected": false,
"visibility": "private"
}
Example HTTP response
Response 200
{
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"created_at": "2025-07-22T09:00:00Z",
"disk_format": "qcow2",
"file": "/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file",
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"min_disk": 100,
"min_ram": 0,
"name": "imagename",
"os_distro": "alma",
"os_hash_algo": "sha512",
"os_hash_value": "c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99",
"os_hidden": false,
"owner": "a8f10467abfc4b87b64614ab36eb9ae4",
"owner_account_name": "AccountName",
"owner_user_name": "user@samsung.com",
"protected": false,
"root_device_name": "/dev/vda",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"scp_os_build_version": "20250101",
"scp_os_version": "8.8",
"size": 2429747200,
"status": "active",
"updated_at": "2025-07-26T12:00:00Z",
"url": "https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2",
"virtual_size": 17179869184,
"visibility": "private",
"volumes": "[{\"tag\": null, \"volume_id\": null, \"encryption_options\": null, \"encryption_secret_uuid\": null, \"encryption_format\": null, \"device_name\": \"/dev/vda\", \"disk_bus\": \"virtio\", \"volume_type\": null, \"encrypted\": null, \"image_id\": null, \"device_type\": \"disk\", \"source_type\": \"snapshot\", \"delete_on_termination\": false, \"volume_size\": 104, \"guest_format\": null, \"boot_index\": 0, \"destination_type\": \"volume\", \"snapshot_id\": \"abde9e38-2ed5-4ecd-b23c-b0120e30690e\", \"no_device\": null}]"
}
1.108 - Update Image member
1.108.1 - 1.2
put /v1/images/{image_id}/members/{member_id}
Description
Update Image member.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | image_id
required | Image ID
Example : 70a599e0-31e7-49b7-b260-868f441e862b
| string | None |
| path | member_id
required | Shared Image member ID
Example : a8f10467abfc4b87b64614ab36eb9ae4
| string | None |
| body | body
required |
| ImageMemberSetRequest | |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | ImageMemberShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/images/{image_id}/members/{member_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
Example HTTP response
Response 200
{
"created_at": "2025-07-22T09:00:00Z",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"member_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"status": "pending",
"updated_at": "2025-07-26T12:00:00Z"
}
1.108.2 - 1.1
put /v1/images/{image_id}/members/{member_id}
Description
Update Image member.
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
| Type | Name | Description | Schema | Default |
|---|
| path | image_id
required | Image ID
Example : 70a599e0-31e7-49b7-b260-868f441e862b
| string | None |
| path | member_id
required | Shared Image member ID
Example : a8f10467abfc4b87b64614ab36eb9ae4
| string | None |
| body | body
required |
| ImageMemberSetRequest | |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | ImageMemberShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/images/{image_id}/members/{member_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
Example HTTP response
Response 200
{
"created_at": "2025-07-22T09:00:00Z",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"member_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"status": "pending",
"updated_at": "2025-07-26T12:00:00Z"
}
1.108.3 - 1.0
put /v1/images/{image_id}/members/{member_id}
Description
Update Image member.
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
| Type | Name | Description | Schema | Default |
|---|
| path | image_id
required | Image ID
Example : 70a599e0-31e7-49b7-b260-868f441e862b
| string | None |
| path | member_id
required | Shared Image member ID
Example : a8f10467abfc4b87b64614ab36eb9ae4
| string | None |
| body | body
required |
| ImageMemberSetRequest | |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | ImageMemberShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/images/{image_id}/members/{member_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
Example HTTP response
Response 200
{
"created_at": "2025-07-22T09:00:00Z",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"member_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"status": "pending",
"updated_at": "2025-07-26T12:00:00Z"
}
1.109 - Update Server Interface
1.109.1 - 1.2
put /v1/servers/{server_id}/interfaces/{port_id}
Description
Update Server Interface.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
| path | port_id
required | Port ID
Example : 91424c08-0b26-49fb-9808-ed042292ceef
| string | None |
| body | body
required |
| ServerInterfaceUpdateRequest | |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces/{port_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"fixed_ip_address": "192.169.3.2",
"subnet_id": ""
}
Example HTTP response
Response 202
1.109.2 - 1.1
put /v1/servers/{server_id}/interfaces/{port_id}
Description
Update Server Interface.
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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
| path | port_id
required | Port ID
Example : 91424c08-0b26-49fb-9808-ed042292ceef
| string | None |
| body | body
required |
| ServerInterfaceUpdateRequest | |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces/{port_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"fixed_ip_address": "192.169.3.2",
"subnet_id": ""
}
Example HTTP response
Response 202
1.109.3 - 1.0
put /v1/servers/{server_id}/interfaces/{port_id}
Description
Update Server Interface.
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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
| path | port_id
required | Port ID
Example : 91424c08-0b26-49fb-9808-ed042292ceef
| string | None |
| body | body
required |
| ServerInterfaceUpdateRequest | |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces/{port_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"fixed_ip_address": "192.169.3.2",
"subnet_id": ""
}
Example HTTP response
Response 202
1.110 - Update Server Volume
1.110.1 - 1.2
put /v1/servers/{server_id}/volumes/{volume_id}
Description
Update Server Volume.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
| path | volume_id
required | Volume ID
Example : 3f500f00-ed80-4566-a057-e31760226f9a
| string | None |
| body | body
required |
| ServerVolumesUpdateRequest | |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/volumes/{volume_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"delete_on_termination": false,
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
Example HTTP response
Response 200
1.110.2 - 1.1
put /v1/servers/{server_id}/volumes/{volume_id}
Description
Update Server Volume.
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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
| path | volume_id
required | Volume ID
Example : 3f500f00-ed80-4566-a057-e31760226f9a
| string | None |
| body | body
required |
| ServerVolumesUpdateRequest | |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/volumes/{volume_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"delete_on_termination": false,
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
Example HTTP response
Response 200
1.110.3 - 1.0
put /v1/servers/{server_id}/volumes/{volume_id}
Description
Update Server Volume.
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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
| path | volume_id
required | Volume ID
Example : 3f500f00-ed80-4566-a057-e31760226f9a
| string | None |
| body | body
required |
| ServerVolumesUpdateRequest | |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/volumes/{volume_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"delete_on_termination": false,
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
Example HTTP response
Response 200
1.111 - Update Virtual Server
1.111.1 - 1.2
put /v1/servers/{server_id}
Description
Update Virtual Server.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
| body | body
required |
| ServerUpdateRequest | |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | ServerShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"addresses": [
{
"ip_addresses": [
{
"ip_address": "192.169.3.2",
"version": 4
}
],
"subnet_name": "subnetname"
}
],
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2026-04-14T15:06:26.981Z",
"created_by": "97e6b22c9a4143789ca522df7457a32f",
"disk_config": "MANUAL",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"is_marketplace": false,
"keypair_name": "keypairname",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"locked": false,
"metadata": "",
"modified_at": "2026-04-14T15:06:26.981Z",
"name": "servername",
"partition_number": 1,
"planned_compute_os_type": "windows",
"product_category": "compute",
"product_offering": "virtual_server",
"security_groups": [
{
"name": "securitygroup"
}
],
"server_group_id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"server_type": {
"disk": 100,
"ephemeral": 0,
"extra_specs": "",
"id": "s1v1m2",
"name": "s1v1m2",
"ram": 2,
"swap": 0,
"vcpus": 1
},
"state": "ACTIVE",
"volumes": [
{
"delete_on_termination": false,
"id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
],
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
1.111.2 - 1.1
put /v1/servers/{server_id}
Description
Update 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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
| body | body
required |
| ServerUpdateRequest | |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | ServerShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"addresses": [
{
"ip_addresses": [
{
"ip_address": "192.169.3.2",
"version": 4
}
],
"subnet_name": "subnetname"
}
],
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2026-04-14T15:06:24.525Z",
"created_by": "97e6b22c9a4143789ca522df7457a32f",
"disk_config": "MANUAL",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"is_marketplace": false,
"keypair_name": "keypairname",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"locked": false,
"metadata": "",
"modified_at": "2026-04-14T15:06:24.525Z",
"name": "servername",
"partition_number": 1,
"planned_compute_os_type": "windows",
"product_category": "compute",
"product_offering": "virtual_server",
"security_groups": [
{
"name": "securitygroup"
}
],
"server_group_id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"server_type": {
"disk": 100,
"ephemeral": 0,
"extra_specs": "",
"id": "s1v1m2",
"name": "s1v1m2",
"ram": 2,
"swap": 0,
"vcpus": 1
},
"state": "ACTIVE",
"volumes": [
{
"delete_on_termination": false,
"id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
],
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
1.111.3 - 1.0
put /v1/servers/{server_id}
Description
Update 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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
| body | body
required |
| ServerUpdateRequest | |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | ServerShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"addresses": [
{
"ip_addresses": [
{
"ip_address": "192.169.3.2",
"version": 4
}
],
"subnet_name": "subnetname"
}
],
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2026-04-14T15:06:21.989Z",
"created_by": "97e6b22c9a4143789ca522df7457a32f",
"disk_config": "MANUAL",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"is_marketplace": false,
"keypair_name": "keypairname",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"locked": false,
"metadata": "",
"modified_at": "2026-04-14T15:06:21.989Z",
"name": "servername",
"partition_number": 1,
"planned_compute_os_type": "windows",
"product_category": "compute",
"product_offering": "virtual_server",
"security_groups": [
{
"name": "securitygroup"
}
],
"server_group_id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"server_type": {
"disk": 100,
"ephemeral": 0,
"extra_specs": "",
"id": "s1v1m2",
"name": "s1v1m2",
"ram": 2,
"swap": 0,
"vcpus": 1
},
"state": "ACTIVE",
"volumes": [
{
"delete_on_termination": false,
"id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
],
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
1.112 - Update Virtual Server type
1.112.1 - 1.2
post /v1/servers/{server_id}/server-type
Description
Update Virtual Server type
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
| body | body
required |
| ServerSetServerTypeRequestBody | |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/server-type
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"server_type": "s1v1m2"
}
Example HTTP response
Response 202
1.112.2 - 1.1
post /v1/servers/{server_id}/server-type
Description
Update Virtual Server type
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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
| body | body
required |
| ServerSetServerTypeRequestBody | |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/server-type
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"server_type": "s1v1m2"
}
Example HTTP response
Response 202
1.112.3 - 1.0
post /v1/servers/{server_id}/server-type
Description
Update Virtual Server type
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
| Type | Name | Description | Schema | Default |
|---|
| path | server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | None |
| body | body
required |
| ServerSetServerTypeRequestBody | |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/server-type
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"server_type": "s1v1m2"
}
Example HTTP response
Response 202
1.113 - Update Volume
1.113.1 - 1.2
put /v1/volumes/{volume_id}
Description
Update a Volume.
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume ID
Example : 3f500f00-ed80-4566-a057-e31760226f9a
| string | None |
| body | body
required |
| VolumeUpdateRequest | |
Responses
Example HTTP request
Request path
/v1/volumes/{volume_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
Example HTTP response
Response 200
{
"bootable": false,
"created_at": "2026-04-14T15:06:28.066Z",
"encrypted": true,
"id": "3f500f00-ed80-4566-a057-e31760226f9a",
"max_iops": 10000,
"max_throughput": 500,
"modified_at": "2025-07-26T12:00:00Z",
"multiattach": false,
"name": "volume01",
"servers": [
{
"attached_at": "2026-04-14T15:06:28.066Z",
"device": "/dev/vda",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
}
],
"size": 104,
"snapshot_id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"state": "available",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_image_metadata": {
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"disk_format": "qcow2",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"min_disk": 100,
"min_ram": 0,
"os_distro": "alma",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"signature_verified": false,
"size": 2429747200
},
"volume_type": "SSD",
"volume_type_id": "c643ac35-3aec-43e6-b97a-3d6f666c5207"
}
1.113.2 - 1.1
put /v1/volumes/{volume_id}
Description
Update a Volume.
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
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume ID
Example : 3f500f00-ed80-4566-a057-e31760226f9a
| string | None |
| body | body
required |
| VolumeUpdateRequest | |
Responses
Example HTTP request
Request path
/v1/volumes/{volume_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
Example HTTP response
Response 200
{
"bootable": false,
"created_at": "2026-04-14T15:06:25.569Z",
"encrypted": true,
"id": "3f500f00-ed80-4566-a057-e31760226f9a",
"modified_at": "2025-07-26T12:00:00Z",
"multiattach": false,
"name": "volume01",
"servers": [
{
"attached_at": "2026-04-14T15:06:25.569Z",
"device": "/dev/vda",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
}
],
"size": 104,
"snapshot_id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"state": "available",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_image_metadata": {
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"disk_format": "qcow2",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"min_disk": 100,
"min_ram": 0,
"os_distro": "alma",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"signature_verified": false,
"size": 2429747200
},
"volume_type": "SSD",
"volume_type_id": "c643ac35-3aec-43e6-b97a-3d6f666c5207"
}
1.113.3 - 1.0
put /v1/volumes/{volume_id}
Description
Update a Volume.
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
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume ID
Example : 3f500f00-ed80-4566-a057-e31760226f9a
| string | None |
| body | body
required |
| VolumeUpdateRequest | |
Responses
Example HTTP request
Request path
/v1/volumes/{volume_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
Example HTTP response
Response 200
{
"bootable": false,
"created_at": "2026-04-14T15:06:23.070Z",
"encrypted": true,
"id": "3f500f00-ed80-4566-a057-e31760226f9a",
"modified_at": "2025-07-26T12:00:00Z",
"multiattach": false,
"name": "volume01",
"servers": [
{
"attached_at": "2026-04-14T15:06:23.070Z",
"device": "/dev/vda",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
}
],
"size": 104,
"snapshot_id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"state": "available",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_image_metadata": {
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"disk_format": "qcow2",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"min_disk": 100,
"min_ram": 0,
"os_distro": "alma",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"signature_verified": false,
"size": 2429747200
},
"volume_type": "SSD",
"volume_type_id": "c643ac35-3aec-43e6-b97a-3d6f666c5207"
}
2 - Models
2.1 - AutoScalingGroup
| Name | Description | Schema | Default |
|---|
account_id
required | Account ID
Example : a8f10467abfc4b87b64614ab36eb9ae4
| string | |
created_at
required | Created At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
created_by
required | Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
desired_server_count
required | Desired server count
Example : 1
| integer | |
desired_server_count_editable
required | Desired server count editable
Example : True
| boolean | |
drain_enabled
required | Drain enabled
Example : True
| boolean | |
drain_timeout
optional | Drain timeout
Example : 300
| any of [integer, null] | |
id
required | ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
| string | |
launch_configuration_id
required | Launch Configuration ID
Example : b5aea5a675fc4f6b9e0fcd1288354c5f
| string | |
launch_configuration_name
required | Launch Configuration name
Example : launch-configuration-name
| string | |
lb_server_groups
optional | LB Server Group list
| any of [array[AutoScalingGroupLbServerGroup], null] | |
max_server_count
required | Max server count
Example : 2
| integer | |
min_server_count
required | Min server count
Example : 1
| integer | |
modified_at
required | Modified At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
modified_by
required | Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
name
required | Auto-Scaling Group name
Example : auto-scaling-group-name
| string | |
security_group_ids
optional | Security Group ID list
Example : ['c09c3f05-03d9-443f-b27a-40e0f973c75f']
| any of [array[string], null] | |
server_name_prefix
required | Server name prefix
Example : server-name-prefix
| string | |
state
required | Auto-Scaling Group state
Example : IN_SERVICE
| string | |
subnet_ids
optional | Subnet ID list
| array[string] | |
vpc_id
required | VPC ID
Example : cc976b621087484ea5fd527f4b78708b
| string | |
2.2 - AutoScalingGroupCreateRequest
| Name | Description | Schema | Default |
|---|
desired_server_count
required | Desired server count
Example : 1
| integer | |
desired_server_count_editable
required | Desired server count editable
Example : True
| boolean | |
drain_enabled
optional | Drain enabled
Example : True
| any of [boolean, null] | |
drain_timeout
optional | Drain timeout
Example : 300
| any of [integer, null] | |
launch_configuration_id
required | Launch Configuration ID
Example : b5aea5a675fc4f6b9e0fcd1288354c5f
| string | |
lb_server_groups
optional | LB Server Group list
| any of [array[AutoScalingGroupLbServerGroup], null] | |
max_server_count
required | Max server count
Example : 2
| integer | |
min_server_count
required | Min server count
Example : 1
| integer | |
name
required | Auto-Scaling Group name
Example : auto-scaling-group-name
Pattern : ^[a-zA-Z0-9-_]*$
Minimum length : 1
Maximum length : 63
| string | |
notifications
optional | Auto-Scaling Group notifications
| any of [array[AutoScalingGroupNotificationCreateRequest], null] | |
scaling_policies
optional | Auto-Scaling Group policy list
| any of [array[AutoScalingGroupPolicyCreateRequest], null] | |
security_group_ids
optional | Security Group ID list
Example : ['c09c3f05-03d9-443f-b27a-40e0f973c75f']
| any of [array[string], null] | |
server_name_prefix
required | Server name prefix
Example : server-name-prefix
Pattern : ^[a-zA-Z0-9-_]*$
Minimum length : 1
Maximum length : 61
| string | |
subnet_ids
required | Subnet ID list
| array[string] | |
tags
optional | Tags
Example : [{'key': 'key', 'value': 'value'}]
| any of [array[Tag], null] | |
2.3 - AutoScalingGroupCreateRequestV1Dot2
| Name | Description | Schema | Default |
|---|
desired_server_count
required | Desired server count
Example : 1
| integer | |
desired_server_count_editable
required | Desired server count editable
Example : True
| boolean | |
drain_enabled
optional | Drain enabled
Example : True
| any of [boolean, null] | |
drain_timeout
optional | Drain timeout
Example : 300
| any of [integer, null] | |
launch_configuration_id
required | Launch Configuration ID
Example : b5aea5a675fc4f6b9e0fcd1288354c5f
| string | |
lb_server_groups
optional | LB Server Group list
| any of [array[AutoScalingGroupLbServerGroup], null] | |
max_server_count
required | Max server count
Example : 2
| integer | |
min_server_count
required | Min server count
Example : 1
| integer | |
name
required | Auto-Scaling Group name
Example : auto-scaling-group-name
Pattern : ^[a-zA-Z0-9-_]*$
Minimum length : 1
Maximum length : 63
| string | |
notifications
optional | Auto-Scaling Group notifications
| any of [array[AutoScalingGroupNotificationCreateRequest], null] | |
scaling_policies
optional | Auto-Scaling Group policy list
| any of [array[AutoScalingGroupPolicyCreateRequest], null] | |
security_group_ids
optional | Security Group ID list
Example : ['c09c3f05-03d9-443f-b27a-40e0f973c75f']
| any of [array[string], null] | |
server_name_prefix
required | Server name prefix
Example : server-name-prefix
Pattern : ^[a-zA-Z0-9-_]*$
Minimum length : 1
Maximum length : 61
| string | |
state_check_delay_time
required | The delay time between ASG VM creation and state check operation
Example : 300
Maximum : 2147483647
| integer | |
subnet_ids
required | Subnet ID list
| array[string] | |
tags
optional | Tags
Example : [{'key': 'key', 'value': 'value'}]
| any of [array[Tag], null] | |
use_lb_state_check
required | Whether LB state check operates or not
Example : True
| boolean | |
2.4 - AutoScalingGroupLbServerGroup
| Name | Description | Schema | Default |
|---|
id
required | LB Server Group ID
Example : d06e87d3-ca9a-461b-8e88-077a542a7335
| string | |
port
required | LB Server Group port
Example : 8080
Minimum : 1
Maximum : 65534
| integer | |
2.5 - AutoScalingGroupLbServerGroupListResponse
2.6 - AutoScalingGroupLbServerGroupSetRequest
2.7 - AutoScalingGroupLbServerGroupShowResponse
| Name | Description | Schema | Default |
|---|
created_at
required | Created At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
created_by
required | Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
id
required | ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
| string | |
modified_at
required | Modified At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
modified_by
required | Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
name
required | LB Server Group name
Example : lb-server-group-name
| string | |
port
required | LB Server Group port
Example : 8080
| integer | |
2.8 - AutoScalingGroupListResponse
| Name | Description | Schema | Default |
|---|
auto_scaling_groups
required | Auto-Scaling Group list
| array[AutoScalingGroup] | |
count
required | count
Example : 20
| integer | |
2.9 - AutoScalingGroupListResponseV1Dot2
| Name | Description | Schema | Default |
|---|
auto_scaling_groups
required | Auto-Scaling Group list
| array[AutoScalingGroupV1Dot2] | |
count
required | count
Example : 20
| integer | |
2.10 - AutoScalingGroupNotificationCreateRequest
| Name | Description | Schema | Default |
|---|
notification_events
required | Auto-Scaling Group notification event list
Example : ['SCALE_OUT', 'SCALE_OUT_FAIL']
| array[enum (SCALE_OUT, SCALE_OUT_FAIL, SCALE_IN, SCALE_IN_FAIL, SATISFIED_POLICY_CONDITIONS)] | |
user_ids
required | User ID list
Example : ['570907805e5447be84b618450ef52o0t']
| array[string] | |
2.11 - AutoScalingGroupNotificationListResponse
2.12 - AutoScalingGroupNotificationShowResponse
| Name | Description | Schema | Default |
|---|
account_id
required | Account ID
Example : a8f10467abfc4b87b64614ab36eb9ae4
| string | |
auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | |
created_at
required | Created At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
created_by
required | Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
id
required | ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
| string | |
modified_at
required | Modified At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
modified_by
required | Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
notification_events
required | Auto-Scaling Group notification event list
Example : ['SCALE_OUT', 'SCALE_OUT_FAIL']
| array[enum (SCALE_OUT, SCALE_OUT_FAIL, SCALE_IN, SCALE_IN_FAIL, SATISFIED_POLICY_CONDITIONS)] | |
notification_state
required | Auto-Scaling Group notification state
Example : ACTIVE
| string | |
user_email
required | User email
Example : scpuser@samsung.com
| string | |
user_id
required | User ID
Example : 570907805e5447be84b618450ef52o0t
| string | |
user_name
required | User name
Example : scpuser
| string | |
2.13 - AutoScalingGroupNotificationUpdateRequest
| Name | Description | Schema | Default |
|---|
notification_events
optional | Auto-Scaling Group notification event list
Example : ['SCALE_OUT', 'SCALE_OUT_FAIL']
| any of [array[enum (SCALE_OUT, SCALE_OUT_FAIL, SCALE_IN, SCALE_IN_FAIL, SATISFIED_POLICY_CONDITIONS)], null] | |
notification_state
optional | Auto-Scaling Group notification state
Example : ACTIVE
| any of [string, null] | |
2.14 - AutoScalingGroupPolicyCreateRequest
| Name | Description | Schema | Default |
|---|
comparison_operator
required | Comparison operator
Example : ge
Pattern : ^(ge|gt|le|lt)$
| string | |
cooldown_seconds
required | Cooldown seconds
Example : 300
| integer | |
evaluation_minutes
required | Evaluation minutes
Example : 5
| integer | |
metric_method
required | Metric method
Example : AVG
Pattern : ^(AVG|MIN|MAX)$
| string | |
metric_type
required | Metric type
Example : CPU
Pattern : ^(CPU|NETWORK_IN_BYTES|NETWORK_OUT_BYTES|NETWORK_IN_PACKETS|NETWORK_OUT_PACKETS)$
| string | |
name
required | Policy name
Example : policy-name
Pattern : ^[a-zA-Z0-9-_]*$
Minimum length : 1
Maximum length : 63
| string | |
scale_method
required | Scale method
Example : AMOUNT
Pattern : ^(AMOUNT|PERCENTAGE|FIXED)$
| string | |
scale_type
required | Scale type
Example : SCALE_OUT
Pattern : ^(SCALE_IN|SCALE_OUT)$
| string | |
scale_value
required | Scale value
Example : 10
| integer | |
threshold
required | Threshold
Example : 60
| integer | |
2.15 - AutoScalingGroupPolicyListResponse
2.16 - AutoScalingGroupPolicyShowResponse
| Name | Description | Schema | Default |
|---|
account_id
required | Account ID
Example : a8f10467abfc4b87b64614ab36eb9ae4
| string | |
auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | |
comparison_operator
required | Comparison operator
Example : ge
| string | |
cooldown_seconds
required | Cooldown seconds
Example : 300
| integer | |
created_at
required | Created At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
created_by
required | Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
evaluation_minutes
required | Evaluation minutes
Example : 5
| integer | |
id
required | ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
| string | |
metric_method
required | Metric method
Example : AVG
| string | |
metric_type
required | Metric type
Example : CPU
| string | |
modified_at
required | Modified At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
modified_by
required | Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
name
required | Policy name
Example : policy-name
| string | |
scale_method
required | Scale method
Example : AMOUNT
| string | |
scale_type
required | Scale type
Example : SCALE_OUT
| string | |
scale_value
required | Scale value
Example : 10
| integer | |
state
required | Policy state
Example : ACTIVE
| string | |
threshold
required | Threshold
Example : 60
| integer | |
threshold_unit
required | Threshold unit
Example : %
| string | |
2.17 - AutoScalingGroupPolicyUpdateRequest
| Name | Description | Schema | Default |
|---|
comparison_operator
optional | Comparison operator
Example : ge
Pattern : ^(ge|gt|le|lt)$
| any of [string, null] | |
cooldown_seconds
optional | Cooldown seconds
Example : 300
| any of [integer, null] | |
evaluation_minutes
optional | Evaluation minutes
Example : 5
| any of [integer, null] | |
metric_method
optional | Metric method
Example : AVG
Pattern : ^(AVG|MIN|MAX)$
| any of [string, null] | |
metric_type
optional | Metric type
Example : CPU
Pattern : ^(CPU|NETWORK_IN_BYTES|NETWORK_OUT_BYTES|NETWORK_IN_PACKETS|NETWORK_OUT_PACKETS)$
| any of [string, null] | |
name
optional | Policy name
Example : policy-name
Pattern : ^[a-zA-Z0-9-_]*$
| any of [string, null] | |
scale_method
optional | Scale method
Example : AMOUNT
Pattern : ^(AMOUNT|PERCENTAGE|FIXED)$
| any of [string, null] | |
scale_type
optional | Scale type
Example : SCALE_OUT
Pattern : ^(SCALE_IN|SCALE_OUT)$
| any of [string, null] | |
scale_value
optional | Scale value
Example : 10
| any of [integer, null] | |
state
optional | Policy state
Example : ACTIVE
Pattern : ^(ACTIVE|INACTIVE)$
| any of [string, null] | |
threshold
optional | Threshold
Example : 60
| any of [integer, null] | |
2.18 - AutoScalingGroupPolicyUpdateRequestV1Dot2
| Name | Description | Schema | Default |
|---|
comparison_operator
optional | Comparison operator
Example : ge
Pattern : ^(ge|gt|le|lt)$
| any of [string, null] | |
cooldown_seconds
optional | Cooldown seconds
Example : 300
| any of [integer, null] | |
evaluation_minutes
optional | Evaluation minutes
Example : 5
| any of [integer, null] | |
metric_method
optional | Metric method
Example : AVG
Pattern : ^(AVG|MIN|MAX)$
| any of [string, null] | |
metric_type
optional | Metric type
Example : CPU
Pattern : ^(CPU|NETWORK_IN_BYTES|NETWORK_OUT_BYTES|NETWORK_IN_PACKETS|NETWORK_OUT_PACKETS)$
| any of [string, null] | |
scale_method
optional | Scale method
Example : AMOUNT
Pattern : ^(AMOUNT|PERCENTAGE|FIXED)$
| any of [string, null] | |
scale_type
optional | Scale type
Example : SCALE_OUT
Pattern : ^(SCALE_IN|SCALE_OUT)$
| any of [string, null] | |
scale_value
optional | Scale value
Example : 10
| any of [integer, null] | |
state
optional | Policy state
Example : ACTIVE
Pattern : ^(ACTIVE|INACTIVE)$
| any of [string, null] | |
threshold
optional | Threshold
Example : 60
| any of [integer, null] | |
2.19 - AutoScalingGroupScheduleCreateRequest
| Name | Description | Schema | Default |
|---|
day_of_month
optional | Day of the month
Example : -1,1
| any of [string, null] | |
day_of_week
optional | Day of the week
Example : SU,SA
| any of [string, null] | |
description
optional | Description
Example : description
| any of [string, null] | |
desired_server_count
optional | Desired server count
Example : 1
| any of [integer, null] | |
end_date
optional | End date
Example : 2025-01-01
| any of [string, null] | |
frequency
required | Frequency
Example : WEEKLY
| enum (ONCE, DAILY, WEEKLY, MONTHLY) | |
hour
required | Hour
Example : 9
Maximum : 23
| integer | |
max_server_count
optional | Max server count
Example : 2
| any of [integer, null] | |
min_server_count
optional | Min server count
Example : 1
| any of [integer, null] | |
minute
required | Minute
Example : 0
| integer | |
name
required | Schedule name
Example : schedulename
Pattern : ^[a-zA-Z0-9-_]*$
Minimum length : 1
Maximum length : 63
| string | |
start_date
required | Start date
Example : 2024-01-01
| string | |
state
optional | Schedule state
Example : ACTIVE
| enum (ACTIVE, INACTIVE, DELETED) | |
timezone
required | Timezone
Example : Asia/Seoul
| string | |
2.20 - AutoScalingGroupScheduleListResponse
| Name | Description | Schema | Default |
|---|
count
required | count
Example : 20
| integer | |
page
required | page
Example : 0
| integer | |
schedules
required |
| array[AutoScalingGroupScheduleShowResponse] | |
size
required | size
Example : 20
| integer | |
sort
optional | sort
Example : ['created_at:asc']
| any of [array[string], null] | |
2.21 - AutoScalingGroupScheduleShowResponse
| Name | Description | Schema | Default |
|---|
account_id
required | Account ID
Example : a8f10467abfc4b87b64614ab36eb9ae4
| string | |
created_at
required | Created At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
created_by
required | Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
day_of_month
required | Day of the month
Example : -1,1
| any of [string, null] | |
day_of_week
required | Day of the week
Example : SU,SA
| any of [string, null] | |
description
required | Description
Example : description
| any of [string, null] | |
desired_server_count
required | Desired server count
Example : 1
| any of [integer, null] | |
end_date
required | End date
Example : 2025-01-01
| any of [string, null] | |
frequency
required | Frequency
Example : WEEKLY
| enum (ONCE, DAILY, WEEKLY, MONTHLY) | |
hour
required | Hour
Example : 9
| integer | |
id
required | ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
| string | |
max_server_count
required | Max server count
Example : 2
| any of [integer, null] | |
min_server_count
required | Min server count
Example : 1
| any of [integer, null] | |
minute
required | Minute
Example : 0
| integer | |
modified_at
required | Modified At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
modified_by
required | Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
name
required | Schedule name
Example : schedulename
| string | |
start_date
required | Start date
Example : 2024-01-01
| string | |
state
required | Schedule state
Example : ACTIVE
| string | |
timezone
required | Timezone
Example : Asia/Seoul
| string | |
2.22 - AutoScalingGroupScheduleUpdateRequest
| Name | Description | Schema | Default |
|---|
day_of_month
optional | Day of the month
Example : -1,1
| any of [string, null] | |
day_of_week
optional | Day of the week
Example : SU,SA
| any of [string, null] | |
description
optional | Description
Example : description
| any of [string, null] | |
desired_server_count
optional | Desired server count
Example : 1
| any of [integer, null] | |
end_date
optional | End date
Example : 2025-01-01
| any of [string, null] | |
frequency
optional | Frequency
Example : WEEKLY
| any of [enum (ONCE, DAILY, WEEKLY, MONTHLY), null] | |
hour
optional | Hour
Example : 9
| any of [integer, null] | |
max_server_count
optional | Max server count
Example : 2
| any of [integer, null] | |
min_server_count
optional | Min server count
Example : 1
| any of [integer, null] | |
minute
optional | Minute
Example : 0
| any of [integer, null] | |
name
optional | Schedule name
Example : schedulename
Pattern : ^[a-zA-Z0-9-_]*$
| any of [string, null] | |
start_date
optional | Start date
Example : 2024-01-01
| any of [string, null] | |
state
optional | Schedule state
Example : ACTIVE
| enum (ACTIVE, INACTIVE, DELETED) | |
timezone
optional | Timezone
Example : Asia/Seoul
| any of [string, null] | |
2.23 - AutoScalingGroupSetRequest
| Name | Description | Schema | Default |
|---|
desired_server_count_editable
optional | Desired server count editable
Example : True
| any of [boolean, null] | |
drain_enabled
optional | Drain enabled
Example : True
| any of [boolean, null] | |
drain_timeout
optional | Drain timeout
Example : 300
| any of [integer, null] | |
launch_configuration_id
optional | Launch Configuration ID
Example : b5aea5a675fc4f6b9e0fcd1288354c5f
| any of [string, null] | |
security_group_ids
optional | Security Group ID list
Example : ['c09c3f05-03d9-443f-b27a-40e0f973c75f']
| any of [array[string], null] | |
2.24 - AutoScalingGroupSetRequestV1Dot2
| Name | Description | Schema | Default |
|---|
desired_server_count_editable
optional | Desired server count editable
Example : True
| any of [boolean, null] | |
drain_enabled
optional | Drain enabled
Example : True
| any of [boolean, null] | |
drain_timeout
optional | Drain timeout
Example : 300
| any of [integer, null] | |
launch_configuration_id
optional | Launch Configuration ID
Example : b5aea5a675fc4f6b9e0fcd1288354c5f
| any of [string, null] | |
security_group_ids
optional | Security Group ID list
Example : ['c09c3f05-03d9-443f-b27a-40e0f973c75f']
| any of [array[string], null] | |
state_check_delay_time
optional | The delay time between ASG VM creation and state check operation
Example : 300
| any of [integer, null] | |
use_lb_state_check
optional | Whether LB state check operates or not
Example : True
| any of [boolean, null] | |
2.25 - AutoScalingGroupSetServerCountRequest
| Name | Description | Schema | Default |
|---|
desired_server_count
optional | Desired server count
Example : 1
| any of [integer, null] | |
max_server_count
optional | Max server count
Example : 2
| any of [integer, null] | |
min_server_count
optional | Min server count
Example : 1
| any of [integer, null] | |
2.26 - AutoScalingGroupShowResponse
| Name | Description | Schema | Default |
|---|
account_id
required | Account ID
Example : a8f10467abfc4b87b64614ab36eb9ae4
| string | |
created_at
required | Created At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
created_by
required | Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
desired_server_count
required | Desired server count
Example : 1
| integer | |
desired_server_count_editable
required | Desired server count editable
Example : True
| boolean | |
drain_enabled
required | Drain enabled
Example : True
| boolean | |
drain_timeout
optional | Drain timeout
Example : 300
| any of [integer, null] | |
id
required | ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
| string | |
launch_configuration_id
required | Launch Configuration ID
Example : b5aea5a675fc4f6b9e0fcd1288354c5f
| string | |
launch_configuration_name
required | Launch Configuration name
Example : launch-configuration-name
| string | |
lb_server_groups
optional | LB Server Group list
| any of [array[AutoScalingGroupLbServerGroup], null] | |
max_server_count
required | Max server count
Example : 2
| integer | |
min_server_count
required | Min server count
Example : 1
| integer | |
modified_at
required | Modified At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
modified_by
required | Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
name
required | Auto-Scaling Group name
Example : auto-scaling-group-name
| string | |
security_group_ids
optional | Security Group ID list
Example : ['c09c3f05-03d9-443f-b27a-40e0f973c75f']
| any of [array[string], null] | |
server_name_prefix
required | Server name prefix
Example : server-name-prefix
| string | |
state
required | Auto-Scaling Group state
Example : IN_SERVICE
| string | |
subnet_ids
optional | Subnet ID list
| array[string] | |
total_server_count
required | Total server count
Example : 1
| integer | |
vpc_id
required | VPC ID
Example : cc976b621087484ea5fd527f4b78708b
| string | |
2.27 - AutoScalingGroupShowResponseV1Dot2
| Name | Description | Schema | Default |
|---|
account_id
required | Account ID
Example : a8f10467abfc4b87b64614ab36eb9ae4
| string | |
created_at
required | Created At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
created_by
required | Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
desired_server_count
required | Desired server count
Example : 1
| integer | |
desired_server_count_editable
required | Desired server count editable
Example : True
| boolean | |
drain_enabled
required | Drain enabled
Example : True
| boolean | |
drain_timeout
optional | Drain timeout
Example : 300
| any of [integer, null] | |
id
required | ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
| string | |
launch_configuration_id
required | Launch Configuration ID
Example : b5aea5a675fc4f6b9e0fcd1288354c5f
| string | |
launch_configuration_name
required | Launch Configuration name
Example : launch-configuration-name
| string | |
lb_server_groups
optional | LB Server Group list
| any of [array[AutoScalingGroupLbServerGroup], null] | |
max_server_count
required | Max server count
Example : 2
| integer | |
min_server_count
required | Min server count
Example : 1
| integer | |
modified_at
required | Modified At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
modified_by
required | Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
name
required | Auto-Scaling Group name
Example : auto-scaling-group-name
| string | |
security_group_ids
optional | Security Group ID list
Example : ['c09c3f05-03d9-443f-b27a-40e0f973c75f']
| any of [array[string], null] | |
server_name_prefix
required | Server name prefix
Example : server-name-prefix
| string | |
state
required | Auto-Scaling Group state
Example : IN_SERVICE
| string | |
state_check_delay_time
required | The delay time between ASG VM creation and state check operation
Example : 300
| integer | |
subnet_ids
optional | Subnet ID list
| array[string] | |
total_server_count
required | Total server count
Example : 1
| integer | |
use_lb_state_check
required | Whether LB state check operates or not
Example : True
| boolean | |
vpc_id
required | VPC ID
Example : cc976b621087484ea5fd527f4b78708b
| string | |
2.28 - AutoScalingGroupV1Dot2
| Name | Description | Schema | Default |
|---|
account_id
required | Account ID
Example : a8f10467abfc4b87b64614ab36eb9ae4
| string | |
created_at
required | Created At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
created_by
required | Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
desired_server_count
required | Desired server count
Example : 1
| integer | |
desired_server_count_editable
required | Desired server count editable
Example : True
| boolean | |
drain_enabled
required | Drain enabled
Example : True
| boolean | |
drain_timeout
optional | Drain timeout
Example : 300
| any of [integer, null] | |
id
required | ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
| string | |
launch_configuration_id
required | Launch Configuration ID
Example : b5aea5a675fc4f6b9e0fcd1288354c5f
| string | |
launch_configuration_name
required | Launch Configuration name
Example : launch-configuration-name
| string | |
lb_server_groups
optional | LB Server Group list
| any of [array[AutoScalingGroupLbServerGroup], null] | |
max_server_count
required | Max server count
Example : 2
| integer | |
min_server_count
required | Min server count
Example : 1
| integer | |
modified_at
required | Modified At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
modified_by
required | Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
name
required | Auto-Scaling Group name
Example : auto-scaling-group-name
| string | |
security_group_ids
optional | Security Group ID list
Example : ['c09c3f05-03d9-443f-b27a-40e0f973c75f']
| any of [array[string], null] | |
server_name_prefix
required | Server name prefix
Example : server-name-prefix
| string | |
state
required | Auto-Scaling Group state
Example : IN_SERVICE
| string | |
state_check_delay_time
required | The delay time between ASG VM creation and state check operation
Example : 300
| integer | |
subnet_ids
optional | Subnet ID list
| array[string] | |
use_lb_state_check
required | Whether LB state check operates or not
Example : True
| boolean | |
vpc_id
required | VPC ID
Example : cc976b621087484ea5fd527f4b78708b
| string | |
2.29 - AutoScalingGroupVirtualServerListResponse
2.30 - AutoScalingGroupVirtualServerListResponseV1Dot2
2.31 - AutoScalingGroupVirtualServerShowResponse
| Name | Description | Schema | Default |
|---|
account_id
required | Account ID
Example : a8f10467abfc4b87b64614ab36eb9ae4
| string | |
addresses
optional | Addresses
| any of [array[ServerShowResponseAddress], null] | |
auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | |
created_at
required | Created at
Example :
| string (date-time) | |
created_by
required | Created by
Example : 97e6b22c9a4143789ca522df7457a32f
| string | |
disk_config
required | Disk config
Example : MANUAL
| string | |
id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | |
image_id
optional | Image ID
Example : 70a599e0-31e7-49b7-b260-868f441e862b
| any of [string, null] | |
is_marketplace
optional | Is Marketplace
Example : False
| any of [boolean, null] | |
keypair_name
optional | Keypair name
Example : keypairname
| any of [string, null] | |
launch_configuration_id
optional | Launch Configuration ID
Example : b5aea5a675fc4f6b9e0fcd1288354c5f
| any of [string, null] | |
lb_linked_state
optional | Load Balancer linked state
Example : ATTACHED
| any of [string, null] | |
locked
required | Locked
Example : False
| boolean | |
metadata
required | Metadata
Example :
| object | |
modified_at
required | Modified at
Example :
| string (date-time) | |
name
required | Server name
Example : servername
| string | |
partition_number
optional | Partition number
Example : 1
| any of [integer, null] | |
planned_compute_os_type
optional | Planned Compute OS type
Example : windows
| any of [enum (open_source, windows, rhel), null] | |
product_category
optional | Product category
Example : compute
| any of [enum (compute, container), null] | |
product_offering
optional | Product offering
Example : virtual_server
| any of [enum (virtual_server, gpu_server, k8s_vm, k8s_gpu_vm), null] | |
security_groups
optional | Security Groups
| any of [array[ServerShowResponseSecurityGroup], null] | |
server_group_id
optional | Server Group ID
Example : 616fb98f-46ca-475e-917e-2563e5a8cd19
| any of [string, null] | |
server_type
required | Server type
| ServerShowResponseServerType | |
state
required | Server state
Example : ACTIVE
| string | |
volumes
required | Volumes
| array[ServerShowResponseVolume] | |
vpc_id
optional | VPC ID
Example : cc976b621087484ea5fd527f4b78708b
| any of [string, null] | |
2.32 - AutoScalingGroupVirtualServerShowResponseV1Dot2
| Name | Description | Schema | Default |
|---|
account_id
required | Account ID
Example : a8f10467abfc4b87b64614ab36eb9ae4
| string | |
addresses
optional | Addresses
| any of [array[ServerShowResponseAddress], null] | |
auto_scaling_group_id
required | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| string | |
created_at
required | Created at
Example :
| string (date-time) | |
created_by
required | Created by
Example : 97e6b22c9a4143789ca522df7457a32f
| string | |
disk_config
required | Disk config
Example : MANUAL
| string | |
id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | |
image_id
optional | Image ID
Example : 70a599e0-31e7-49b7-b260-868f441e862b
| any of [string, null] | |
is_asg_virtual_server_healthy
optional | Health state of ASG Virtual Server
Example : True
| boolean | |
is_lb_healthy
required | LB Health State of ASG Virtual Server
Example : True
| boolean | |
is_marketplace
optional | Is Marketplace
Example : False
| any of [boolean, null] | |
keypair_name
optional | Keypair name
Example : keypairname
| any of [string, null] | |
launch_configuration_id
optional | Launch Configuration ID
Example : b5aea5a675fc4f6b9e0fcd1288354c5f
| any of [string, null] | |
lb_linked_state
optional | Load Balancer linked state
Example : ATTACHED
| any of [string, null] | |
locked
required | Locked
Example : False
| boolean | |
metadata
required | Metadata
Example :
| object | |
modified_at
required | Modified at
Example :
| string (date-time) | |
name
required | Server name
Example : servername
| string | |
partition_number
optional | Partition number
Example : 1
| any of [integer, null] | |
planned_compute_os_type
optional | Planned Compute OS type
Example : windows
| any of [enum (open_source, windows, rhel), null] | |
product_category
optional | Product category
Example : compute
| any of [enum (compute, container), null] | |
product_offering
optional | Product offering
Example : virtual_server
| any of [enum (virtual_server, gpu_server, k8s_vm, k8s_gpu_vm), null] | |
security_groups
optional | Security Groups
| any of [array[ServerShowResponseSecurityGroup], null] | |
server_group_id
optional | Server Group ID
Example : 616fb98f-46ca-475e-917e-2563e5a8cd19
| any of [string, null] | |
server_type
required | Server type
| ServerShowResponseServerType | |
state
required | Server state
Example : ACTIVE
| string | |
volumes
required | Volumes
| array[ServerShowResponseVolume] | |
vpc_id
optional | VPC ID
Example : cc976b621087484ea5fd527f4b78708b
| any of [string, null] | |
2.33 - DefaultConfigListResponse
| Name | Description | Schema | Default |
|---|
configs
required | Configs
Example : ('key': 'value'}
| object | |
count
required | count
Example : 20
| integer | |
2.34 - ImageCreateRequest
| Name | Description | Schema | Default |
|---|
container_format
optional | Container format
Example : bare
Pattern : bare
| string | bare |
disk_format
optional | Disk format
Example : qcow2
Pattern : qcow2
| string | qcow2 |
min_disk
optional | Minimum disk capacity (GB) of the Image to be created
Example : 100
| integer | |
min_ram
optional | Minimum RAM capacity (GB) of the Image to be created
Example : 0
Maximum : 2097151
| integer | |
name
required | Image name
Example : imagename
Pattern : ^[a-zA-Z0-9-_ ]*$
Minimum length : 1
Maximum length : 255
| string | |
os_distro
required | OS distribution of the image to be uploaded
Example : alma
| enum (alma, centos, rhel, rocky, ubuntu, windows, oracle) | |
protected
optional | whether Image deletion is prohibited
Example : False
| boolean | |
tags
optional | Tags
Example : [{'key': 'key', 'value': 'value'}]
| any of [array[Tag], null] | |
url
required | Object Storage URL for Image file (only qcow2 format allowed)
Example : https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2
Maximum length : 255
| string | |
visibility
optional | Indicates access permissions for the Image. Private: Can be used only within the Account, Shared: Can be shared between Accounts
Example : private
Pattern : private|shared
| string | private |
2.35 - ImageImportRequest
| Name | Description | Schema | Default |
|---|
url
required | Object Storage URL for Image file (only qcow2 format allowed)
Example : https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2
Pattern : .*\.qcow2$
Maximum length : 255
| string | |
2.37 - ImageListResponseV1Dot2
2.38 - ImageMemberCreateRequest
| Name | Description | Schema | Default |
|---|
member_id
required | Shared Image member ID
Example : a8f10467abfc4b87b64614ab36eb9ae4
Pattern : ^[A-Za-z0-9-]*$
Minimum length : 1
Maximum length : 64
| string | |
2.39 - ImageMemberListResponse
2.40 - ImageMemberSetRequest
| Name | Description | Schema | Default |
|---|
status
required | Status of this Image member. Value of one of pending, accepted, rejected.
Example : pending
| enum (pending, accepted, rejected) | |
2.41 - ImageMemberShowResponse
| Name | Description | Schema | Default |
|---|
created_at
required | Created at
Example : 2025-07-22T09:00:00Z
| string | |
image_id
required | Image ID
Example : 70a599e0-31e7-49b7-b260-868f441e862b
| string | |
member_id
required | Shared Image member ID
Example : a8f10467abfc4b87b64614ab36eb9ae4
| string | |
status
required | Status of this Image member. Value of one of pending, accepted, rejected.
Example : pending
| string | |
updated_at
required | Updated at
Example : 2025-07-26T12:00:00Z
| string | |
2.42 - ImageSetRequest
| Name | Description | Schema | Default |
|---|
min_disk
optional | Minimum disk capacity (GB) of the Image to be created
Example : 100
| any of [integer, null] | |
min_ram
optional | Minimum RAM capacity (GB) of the Image to be created
Example : 0
| any of [integer, null] | |
protected
optional | whether Image deletion is prohibited
Example : False
| any of [boolean, null] | |
visibility
optional | Indicates access permissions for the Image. Private: Can be used only within the Account, Shared: Can be shared between Accounts
Example : private
Pattern : private|shared
| any of [string, null] | |
2.43 - ImageShowResponse
| Name | Description | Schema | Default |
|---|
checksum
optional | MD5 hash of the entire image data. and this field could be used to verify the integrity of image.
Example : 7538e0fcb56e0e272cfd89eb384d6613
| any of [string, null] | |
container_format
required | Container format
Example : bare
| string | |
created_at
required | Created at
Example : 2025-07-22T09:00:00Z
| string | |
disk_format
required | Disk format
Example : qcow2
| string | |
file
required | The URL for the virtual server image file
Example : /v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file
| string | |
id
required | Image ID
Example : 70a599e0-31e7-49b7-b260-868f441e862b
| string | |
min_disk
required | Minimum disk capacity (GB) of the Image to be created
Example : 100
| integer | |
min_ram
required | Minimum RAM capacity (GB) of the Image to be created
Example : 0
| integer | |
name
required | Image name
Example : imagename
| string | |
os_distro
optional | OS distribution of the image to be uploaded
Example : alma
| any of [string, null] | |
os_hash_algo
optional | OS hash algorithm used to verify image integrity
Example : sha512
| any of [string, null] | |
os_hash_value
optional | The actual digest of the image binary, calculated with the algorithm indicated by os_hash_algo. The value is presented as a hexadecimal string.
Example : c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99
| any of [string, null] | |
os_hidden
required | Whether the image is hidden
Example : False
| boolean | |
owner
required | Owner account ID
Example : a8f10467abfc4b87b64614ab36eb9ae4
| string | |
owner_account_name
optional | Owner account name
Example : AccountName
| any of [string, null] | |
owner_user_name
optional | Owner user name
Example : user@samsung.com
| any of [string, null] | |
protected
required | whether Image deletion is prohibited
Example : False
| boolean | |
root_device_name
optional | Root device name
Example : /dev/vda
| any of [string, null] | |
scp_image_type
optional | Image type
Example : custom
| any of [string, null] | |
scp_k8s_version
optional | K8S version
Example : v1.28.7
| any of [string, null] | |
scp_original_image_type
optional | Original Image type
Example : standard
| any of [string, null] | |
scp_os_build_version
optional | OS build version
Example : 20250101
| any of [string, null] | |
scp_os_version
optional | OS version
Example : 8.8
| any of [string, null] | |
size
optional | Image size
Example : 2429747200
| any of [integer, null] | |
status
required | Image status
Example : active
| string | |
updated_at
required | Updated at
Example : 2025-07-26T12:00:00Z
| string | |
url
optional | Object Storage URL for Image file (only qcow2 format allowed)
Example : https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2
| any of [string, null] | |
virtual_size
optional | Virtual size
Example : 17179869184
| any of [integer, null] | |
visibility
required | Indicates access permissions for the Image. Private: Can be used only within the Account, Shared: Can be shared between Accounts
Example : private
| string | |
volumes
optional | Volumes
Example : [{"tag": null, "volume_id": null, "encryption_options": null, "encryption_secret_uuid": null, "encryption_format": null, "device_name": "/dev/vda", "disk_bus": "virtio", "volume_type": null, "encrypted": null, "image_id": null, "device_type": "disk", "source_type": "snapshot", "delete_on_termination": false, "volume_size": 104, "guest_format": null, "boot_index": 0, "destination_type": "volume", "snapshot_id": "abde9e38-2ed5-4ecd-b23c-b0120e30690e", "no_device": null}]
| any of [string, null] | |
2.44 - ImageShowResponseV1Dot2
| Name | Description | Schema | Default |
|---|
checksum
optional | MD5 hash of the entire image data. and this field could be used to verify the integrity of image.
Example : 7538e0fcb56e0e272cfd89eb384d6613
| any of [string, null] | |
container_format
required | Container format
Example : bare
| string | |
created_at
required | Created at
Example : 2025-07-22T09:00:00Z
| string | |
disk_format
required | Disk format
Example : qcow2
| string | |
file
required | The URL for the virtual server image file
Example : /v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file
| string | |
id
required | Image ID
Example : 70a599e0-31e7-49b7-b260-868f441e862b
| string | |
min_disk
required | Minimum disk capacity (GB) of the Image to be created
Example : 100
| integer | |
min_ram
required | Minimum RAM capacity (GB) of the Image to be created
Example : 0
| integer | |
name
required | Image name
Example : imagename
| string | |
os_distro
optional | OS distribution of the image to be uploaded
Example : alma
| any of [string, null] | |
os_hash_algo
optional | OS hash algorithm used to verify image integrity
Example : sha512
| any of [string, null] | |
os_hash_value
optional | The actual digest of the image binary, calculated with the algorithm indicated by os_hash_algo. The value is presented as a hexadecimal string.
Example : c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99
| any of [string, null] | |
os_hidden
required | Whether the image is hidden
Example : False
| boolean | |
owner
required | Owner account ID
Example : a8f10467abfc4b87b64614ab36eb9ae4
| string | |
owner_account_name
optional | Owner account name
Example : AccountName
| any of [string, null] | |
owner_user_name
optional | Owner user name
Example : user@samsung.com
| any of [string, null] | |
protected
required | whether Image deletion is prohibited
Example : False
| boolean | |
root_device_name
optional | Root device name
Example : /dev/vda
| any of [string, null] | |
scp_gpu_driver
optional | K8s GPU Image driver version
Example : 535.183.06
| any of [string, null] | |
scp_image_type
optional | Image type
Example : custom
| any of [string, null] | |
scp_k8s_version
optional | K8S version
Example : v1.28.7
| any of [string, null] | |
scp_original_image_type
optional | Original Image type
Example : standard
| any of [string, null] | |
scp_os_build_version
optional | OS build version
Example : 20250101
| any of [string, null] | |
scp_os_version
optional | OS version
Example : 8.8
| any of [string, null] | |
size
optional | Image size
Example : 2429747200
| any of [integer, null] | |
status
required | Image status
Example : active
| string | |
updated_at
required | Updated at
Example : 2025-07-26T12:00:00Z
| string | |
url
optional | Object Storage URL for Image file (only qcow2 format allowed)
Example : https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2
| any of [string, null] | |
virtual_size
optional | Virtual size
Example : 17179869184
| any of [integer, null] | |
visibility
required | Indicates access permissions for the Image. Private: Can be used only within the Account, Shared: Can be shared between Accounts
Example : private
| string | |
volumes
optional | Volumes
Example : [{"tag": null, "volume_id": null, "encryption_options": null, "encryption_secret_uuid": null, "encryption_format": null, "device_name": "/dev/vda", "disk_bus": "virtio", "volume_type": null, "encrypted": null, "image_id": null, "device_type": "disk", "source_type": "snapshot", "delete_on_termination": false, "volume_size": 104, "guest_format": null, "boot_index": 0, "destination_type": "volume", "snapshot_id": "abde9e38-2ed5-4ecd-b23c-b0120e30690e", "no_device": null}]
| any of [string, null] | |
2.45 - InterfaceAttachmentFixedIp
| Name | Description | Schema | Default |
|---|
ip_address
required | IP address
Example : 192.169.3.2
| string | |
2.46 - InterfaceResponse
| Name | Description | Schema | Default |
|---|
fixed_ips
required | Fixed IP list
| array[InterfaceAttachmentFixedIp] | |
mac_addr
required | MAC Address
Example : fa:16:3e:c0:71:2b
| string | |
port_id
required | Port ID
Example : f2b02fc5-a5fd-4b5f-b1a9-987f4c0d66cc
| string | |
port_state
required | Port State
Example : ACTIVE
| string | |
private_static_nat
optional | Private Static NAT
| PrivateStaticNat | |
static_nat
optional | Public Static NAT
| PublicStaticNat | |
subnet_id
required | Subnet ID
Example : 183c6c30df0c4fcbb16422aa2d64aa21
| string | |
2.47 - InterfaceResponseV1Dot2
| Name | Description | Schema | Default |
|---|
fixed_ips
required | Fixed IP list
| array[InterfaceAttachmentFixedIp] | |
is_default
required | Indicates whether this is the default port.
Example : True
| boolean | |
mac_addr
required | MAC Address
Example : fa:16:3e:c0:71:2b
| string | |
port_id
required | Port ID
Example : f2b02fc5-a5fd-4b5f-b1a9-987f4c0d66cc
| string | |
port_state
required | Port State
Example : ACTIVE
| string | |
private_static_nat
optional | Private Static NAT
| PrivateStaticNat | |
static_nat
optional | Public Static NAT
| PublicStaticNat | |
subnet_id
required | Subnet ID
Example : 183c6c30df0c4fcbb16422aa2d64aa21
| string | |
2.48 - Keypair
| Name | Description | Schema | Default |
|---|
fingerprint
required | Fingerprint
Example : 7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd
| string | |
name
required | Keypair name
Example : keypairname
| string | |
public_key
required | Public Key
Example : ssh-rsa fakeKey Generated-by-SCP
| string | |
type
required | Keypair type
Example : ssh
| string | |
2.49 - KeypairCreateRequest
| Name | Description | Schema | Default |
|---|
name
required | Keypair name
Example : keypairname
Pattern : ^[a-zA-Z0-9-_ ]*$
Minimum length : 1
Maximum length : 255
| string | |
public_key
optional | Public Key
Example : ssh-rsa fakeKey Generated-by-SCP
| any of [string, null] | |
tags
optional | Tags
Example : [{'key': 'key', 'value': 'value'}]
| any of [array[Tag], null] | |
2.50 - KeypairCreateResponse
| Name | Description | Schema | Default |
|---|
fingerprint
required | Fingerprint
Example : 7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd
| string | |
name
required | Keypair name
Example : keypairname
| string | |
private_key
optional | Private key
Example : `—–BEGIN RSA PRIVATE KEY—– | | |
| fakeKey | | | |
—–END RSA PRIVATE KEY—–`
| any of [string, null] | | |
public_key
required | Public Key
Example : ssh-rsa fakeKey Generated-by-SCP
| string | |
type
required | Keypair type
Example : ssh
| string | |
2.51 - KeypairListResponse
| Name | Description | Schema | Default |
|---|
keypairs
required |
| array[Keypair] | |
2.52 - KeypairShowResponse
| Name | Description | Schema | Default |
|---|
created_at
required | Created at
Example : 2025-07-22T09:00:00Z
| string (date-time) | |
fingerprint
required | Fingerprint
Example : 7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd
| string | |
id
required | Keypair ID
Example : 1
| integer | |
name
required | Keypair name
Example : keypairname
| string | |
public_key
required | Public Key
Example : ssh-rsa fakeKey Generated-by-SCP
| string | |
type
required | Keypair type
Example : ssh
| string | |
user_id
required | User ID
Example : 570907805e5447be84b618450ef52o0t
| string | |
2.53 - LaunchConfigurationCreateRequest
| Name | Description | Schema | Default |
|---|
image_id
required | Image ID
Example : 70a599e0-31e7-49b7-b260-868f441e862b
| string | |
keypair_name
required | Keypair name
Example : keypairname
| string | |
name
required | Launch Configuration name
Example : launch-configuration-name
Pattern : ^[a-zA-Z0-9-_]*$
Minimum length : 1
Maximum length : 63
| string | |
server_type_id
required | Server type ID
Example : s1v1m2
| string | |
tags
optional | Tags
Example : [{'key': 'key', 'value': 'value'}]
| any of [array[Tag], null] | |
user_data
optional | A script that runs at the start of a server on Auto-Scaling Group that will use Launch Configuration.It must be Base64-encoded string and must not exceed 45,000 bytes.
Example : IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==
| any of [string, null] | |
volumes
optional | Volumes
| any of [array[LaunchConfigurationVolume], null] | |
2.54 - LaunchConfigurationDetailShowResponse
| Name | Description | Schema | Default |
|---|
account_id
required | Account ID
Example : a8f10467abfc4b87b64614ab36eb9ae4
| string | |
auto_scaling_group_count
optional | Number of Auto-Scaling Group attached to Launch Configuration
Example : 1
| any of [integer, null] | |
created_at
required | Created At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
created_by
required | Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
id
required | ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
| string | |
image_id
required | Image ID
Example : 70a599e0-31e7-49b7-b260-868f441e862b
| string | |
image_name
required | Image name
Example : imagename
| string | |
keypair_name
required | Keypair name
Example : keypairname
| string | |
modified_at
required | Modified At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
modified_by
required | Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
name
required | Launch Configuration name
Example : launch-configuration-name
| string | |
public_key
optional | Public Key
Example : ssh-rsa fakeKey Generated-by-SCP
| any of [string, null] | |
server_type_id
required | Server type ID
Example : s1v1m2
| string | |
state
required | Launch Configuration state
Example : ACTIVE
| string | |
user_data
optional | A script that runs at the start of a server on Auto-Scaling Group that will use Launch Configuration.It must be Base64-encoded string and must not exceed 45,000 bytes.
Example : IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==
| any of [string, null] | |
volumes
optional | Volumes
| any of [array[LaunchConfigurationVolume], null] | |
2.55 - LaunchConfigurationDetailShowResponseV1Dot2
| Name | Description | Schema | Default |
|---|
account_id
required | Account ID
Example : a8f10467abfc4b87b64614ab36eb9ae4
| string | |
auto_scaling_group_count
optional | Number of Auto-Scaling Group attached to Launch Configuration
Example : 1
| any of [integer, null] | |
created_at
required | Created At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
created_by
required | Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
file_storage_ids
optional | File Storage ID list
Example :
| any of [array[string], null] | |
id
required | ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
| string | |
image_id
required | Image ID
Example : 70a599e0-31e7-49b7-b260-868f441e862b
| string | |
image_name
required | Image name
Example : imagename
| string | |
keypair_name
required | Keypair name
Example : keypairname
| string | |
modified_at
required | Modified At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
modified_by
required | Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
name
required | Launch Configuration name
Example : launch-configuration-name
| string | |
public_key
optional | Public Key
Example : ssh-rsa fakeKey Generated-by-SCP
| any of [string, null] | |
server_type_id
required | Server type ID
Example : s1v1m2
| string | |
state
required | Launch Configuration state
Example : ACTIVE
| string | |
user_data
optional | A script that runs at the start of a server on Auto-Scaling Group that will use Launch Configuration.It must be Base64-encoded string and must not exceed 45,000 bytes.
Example : IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==
| any of [string, null] | |
volumes
optional | Volumes
| any of [array[LaunchConfigurationVolumeV1Dot2], null] | |
2.56 - LaunchConfigurationListResponse
| Name | Description | Schema | Default |
|---|
count
optional | count
Example : 20
| integer | |
launch_configurations
required | Launch Configuration list
| array[LaunchConfigurationShowResponse] | |
2.57 - LaunchConfigurationListResponseV1Dot2
2.58 - LaunchConfigurationShowResponse
| Name | Description | Schema | Default |
|---|
account_id
required | Account ID
Example : a8f10467abfc4b87b64614ab36eb9ae4
| string | |
auto_scaling_group_count
optional | Number of Auto-Scaling Group attached to Launch Configuration
Example : 1
| any of [integer, null] | |
boot_disk_size
optional | Size of default volume
Example : 104
| any of [integer, null] | |
created_at
required | Created At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
created_by
required | Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
extra_disk_size
optional | Size of additional volume
Example : 104
| any of [integer, null] | |
id
required | ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
| string | |
image_id
required | Image ID
Example : 70a599e0-31e7-49b7-b260-868f441e862b
| string | |
image_name
required | Image name
Example : imagename
| string | |
keypair_name
required | Keypair name
Example : keypairname
| string | |
modified_at
required | Modified At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
modified_by
required | Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
name
required | Launch Configuration name
Example : launch-configuration-name
| string | |
public_key
optional | Public Key
Example : ssh-rsa fakeKey Generated-by-SCP
| any of [string, null] | |
server_type_id
required | Server type ID
Example : s1v1m2
| string | |
state
required | Launch Configuration state
Example : ACTIVE
| string | |
user_data
optional | A script that runs at the start of a server on Auto-Scaling Group that will use Launch Configuration.It must be Base64-encoded string and must not exceed 45,000 bytes.
Example : IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==
| any of [string, null] | |
volumes
optional | Volumes
| any of [array[LaunchConfigurationVolume], null] | |
2.59 - LaunchConfigurationShowResponseV1Dot2
| Name | Description | Schema | Default |
|---|
account_id
required | Account ID
Example : a8f10467abfc4b87b64614ab36eb9ae4
| string | |
auto_scaling_group_count
optional | Number of Auto-Scaling Group attached to Launch Configuration
Example : 1
| any of [integer, null] | |
boot_disk_size
optional | Size of default volume
Example : 104
| any of [integer, null] | |
created_at
required | Created At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
created_by
required | Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
extra_disk_size
optional | Size of additional volume
Example : 104
| any of [integer, null] | |
file_storage_ids
optional | File Storage ID list
Example :
| any of [array[string], null] | |
id
required | ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
| string | |
image_id
required | Image ID
Example : 70a599e0-31e7-49b7-b260-868f441e862b
| string | |
image_name
required | Image name
Example : imagename
| string | |
keypair_name
required | Keypair name
Example : keypairname
| string | |
modified_at
required | Modified At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
modified_by
required | Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
name
required | Launch Configuration name
Example : launch-configuration-name
| string | |
public_key
optional | Public Key
Example : ssh-rsa fakeKey Generated-by-SCP
| any of [string, null] | |
server_type_id
required | Server type ID
Example : s1v1m2
| string | |
state
required | Launch Configuration state
Example : ACTIVE
| string | |
user_data
optional | A script that runs at the start of a server on Auto-Scaling Group that will use Launch Configuration.It must be Base64-encoded string and must not exceed 45,000 bytes.
Example : IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==
| any of [string, null] | |
volumes
optional | Volumes
| any of [array[LaunchConfigurationVolume], null] | |
2.60 - LaunchConfigurationVolume
| Name | Description | Schema | Default |
|---|
boot_index
required | Boot index
Example : 0
| integer | |
size
required | Volume size
Example : 104
| integer | |
type
optional | Volume type
Example : SSD
| any of [string, null] | |
2.61 - LaunchConfigurationVolumeV1Dot2
| Name | Description | Schema | Default |
|---|
boot_index
required | Boot index
Example : 0
| integer | |
max_iops
optional | The number of distinct read or write operations a volume can process in a single second.
Example : 10000
| any of [integer, null] | |
max_throughput
optional | The actual amount of data (volume) transferred to or from the storage device per second.
Example : 500
| any of [integer, null] | |
size
required | Volume size
Example : 104
| integer | |
type
optional | Volume type
Example : SSD
| any of [string, null] | |
2.62 - Network
| Name | Description | Schema | Default |
|---|
fixed_ip
optional | Fixed Ip
Example : 192.169.3.2
| any of [string, null] | |
port_id
optional | Port ID
Example : 91424c08-0b26-49fb-9808-ed042292ceef
| any of [string, null] | |
public_ip_id
optional | Public IP ID
Example : 615fa9cd5cff486c9de679b3ce63e601
| any of [string, null] | |
subnet_id
optional | Subnet ID
Example : 78b2ee3f074145c580ab6abac4821f97
| any of [string, null] | |
2.63 - PrivateStaticNat
| Name | Description | Schema | Default |
|---|
external_ip_address
required | External IP Address
Example : 182.197.61.81
| string | |
id
required | NAT ID
Example : 224b80106e6f41b38efe98ac9ddbf280
| string | |
private_nat_ip_id
optional | Private NAT IP ID
Example : 1f0cb5390c40483592ddc5a282f53496
| any of [string, null] | |
state
required | NAT State
Example : ACTIVE
| string | |
2.64 - PublicStaticNat
| Name | Description | Schema | Default |
|---|
external_ip_address
required | External IP Address
Example : 182.197.61.81
| string | |
id
required | NAT ID
Example : 224b80106e6f41b38efe98ac9ddbf280
| string | |
publicip_id
optional | Public IP ID
Example : 615fa9cd5cff486c9de679b3ce63e601
| any of [string, null] | |
state
required | NAT State
Example : ACTIVE
| string | |
2.65 - SecurityGroupResponse
| Name | Description | Schema | Default |
|---|
account_id
required | Security Group owner’s account ID
Example : 6f70656e737461636b20342065766572
| string | |
description
required | Security group description
Example : Security group description
| string | |
id
required | Security Group ID
Example : 616fb98f-46ca-475e-917e-2563e5a8cd19
| string | |
name
required | Security Group name
Example : securitygroup
| string | |
rules
required | Security group rules
| array[SecurityGroupResponseRule] | |
2.66 - SecurityGroupResponseRule
| Name | Description | Schema | Default |
|---|
from_port
required | The port at start of range.
Example : 1
| any of [integer, null] | |
id
required | Security group rule ID
Example : ca5cb96b-9df6-4af7-9682-4d60a58d38a5
| string | |
ip_protocol
required | IP protocol
Example : tcp
| any of [string, null] | |
ip_range
optional | IP range
| any of [SecurityGroupResponseRuleIpRange, null] | |
to_port
required | The port at end of range.
Example : 65535
| any of [integer, null] | |
2.67 - SecurityGroupResponseRuleIpRange
| Name | Description | Schema | Default |
|---|
cidr
optional | CIDR
Example : 0.0.0.0/0
| any of [string, null] | |
2.68 - ServerConsoleLogResponse
| Name | Description | Schema | Default |
|---|
output
optional | Server console log output
Example : FAKE CONSOLE OUTPUT
| any of [string, null] | |
2.69 - ServerCreateImageRequestBody
| Name | Description | Schema | Default |
|---|
image_name
required | Image name
Example : imagename
| string | |
2.70 - ServerCreateImageResponse
| Name | Description | Schema | Default |
|---|
image_id
required | Image ID
Example : 70a599e0-31e7-49b7-b260-868f441e862b
| string | |
2.71 - ServerCreateRequest
| Name | Description | Schema | Default |
|---|
image_id
required | Image ID
Example : 70a599e0-31e7-49b7-b260-868f441e862b
| string | |
keypair_name
required | Keypair name
Example : keypairname
| string | |
lock
optional | Sets the server’s lock status. When the server is locked, most user actions are not allowed.
Example : False
| any of [boolean, null] | |
max_count
optional | Maximum number of servers to launch.
Example : 2
| any of [integer, null] | 1 |
metadata
optional | User can specify custom server metadata as a set of key-value pairs.
Example :
| any of [object, null] | |
name
required | Server name
Example : servername
Pattern : ^[a-zA-Z0-9-_ ]*$
Minimum length : 1
Maximum length : 63
| string | |
networks
required | List of Network
| array[Network] | |
partition_number
optional | Sets the target partition number for server creation. only usable if server group type is partition.
Example : 1
| any of [integer, null] | |
product_category
optional | Product category
Example : compute
| any of [enum (compute, container), null] | |
product_offering
optional | Product offering
Example : virtual_server
| any of [enum (virtual_server, gpu_server, k8s_vm, k8s_gpu_vm), null] | |
security_groups
optional | Security Groups
Example : ['c09c3f05-03d9-443f-b27a-40e0f973c75f']
| any of [array[string], null] | |
server_group_id
optional | Server Group ID
Example : 616fb98f-46ca-475e-917e-2563e5a8cd19
| any of [string, null] | |
server_type_id
required | Server type ID
Example : s1v1m2
| string | |
tags
optional | Tags
Example : [{'key': 'key', 'value': 'value'}]
| any of [array[Tag], null] | |
user_data
optional | Script or configuration to run when the server starts. it must be Base64-encoded string and must not exceed 65535 bytes.
Example : IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==
| any of [string, null] | |
volumes
optional | Volumes
| any of [array[Volume], null] | |
2.72 - ServerCreateRequestV1Dot2
| Name | Description | Schema | Default |
|---|
file_storage_ids
optional | File Storage ID list
Example : ['96d258ea-dd5d-4cca-bb3a-b6909b7e2065', '949bd9c7-2098-4284-9685-13268d193117']
| any of [array[string], null] | |
image_id
required | Image ID
Example : 70a599e0-31e7-49b7-b260-868f441e862b
| string | |
keypair_name
required | Keypair name
Example : keypairname
| string | |
lock
optional | Sets the server’s lock status. When the server is locked, most user actions are not allowed.
Example : False
| any of [boolean, null] | |
max_count
optional | Maximum number of servers to launch.
Example : 2
| any of [integer, null] | 1 |
metadata
optional | User can specify custom server metadata as a set of key-value pairs.
Example :
| any of [object, null] | |
name
required | Server name
Example : servername
Pattern : ^[a-zA-Z0-9-_ ]*$
Minimum length : 1
Maximum length : 63
| string | |
networks
required | List of Network
| array[Network] | |
partition_number
optional | Sets the target partition number for server creation. only usable if server group type is partition.
Example : 1
| any of [integer, null] | |
product_category
optional | Product category
Example : compute
| any of [enum (compute, container), null] | |
product_offering
optional | Product offering
Example : virtual_server
| any of [enum (virtual_server, gpu_server, k8s_vm, k8s_gpu_vm), null] | |
security_groups
optional | Security Groups
Example : ['c09c3f05-03d9-443f-b27a-40e0f973c75f']
| any of [array[string], null] | |
server_group_id
optional | Server Group ID
Example : 616fb98f-46ca-475e-917e-2563e5a8cd19
| any of [string, null] | |
server_type_id
required | Server type ID
Example : s1v1m2
| string | |
tags
optional | Tags
Example : [{'key': 'key', 'value': 'value'}]
| any of [array[Tag], null] | |
user_data
optional | Script or configuration to run when the server starts. it must be Base64-encoded string and must not exceed 65535 bytes.
Example : IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==
| any of [string, null] | |
volumes
required | Volumes
| array[VolumeV1Dot2] | |
2.73 - ServerCreateResponse
2.74 - ServerCreateResponseParam
| Name | Description | Schema | Default |
|---|
id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | |
2.75 - ServerGroup
| Name | Description | Schema | Default |
|---|
account_id
required | Account ID
Example : a8f10467abfc4b87b64614ab36eb9ae4
| string | |
id
required | Server Group ID
Example : 616fb98f-46ca-475e-917e-2563e5a8cd19
| string | |
members
required | List of Virtual Servers belonging to Server Group
Example : ['2a9be312-5d4b-4bc8-b2ae-35100fa9241f']
| array[string] | |
name
required | Server Group name
Example : server-group
| string | |
partition_size
required | Size of partition when server group policy is partition
Example : 3
| any of [integer, null] | |
policy
required | Server Group policy
Example : anti-affinity
| string | |
user_id
required | User ID
Example : 570907805e5447be84b618450ef52o0t
| string | |
2.76 - ServerGroupCreateRequest
| Name | Description | Schema | Default |
|---|
name
required | Server Group name
Example : server-group
Pattern : ^[a-zA-Z0-9-_ ]*$
Minimum length : 1
Maximum length : 255
| string | |
policy
required | Server Group policy
Example : anti-affinity
Pattern : ^affinity$|^anti-affinity$|^partition$
| string | |
tags
optional | Tags
Example : [{'key': 'key', 'value': 'value'}]
| any of [array[Tag], null] | |
2.77 - ServerGroupListResponse
| Name | Description | Schema | Default |
|---|
server_groups
required | Server Group list
| array[ServerGroup] | |
2.78 - ServerGroupPartitionSizeResponse
| Name | Description | Schema | Default |
|---|
partition_size
required |
Example :
| integer | |
2.79 - ServerInterfaceCreateRequest
| Name | Description | Schema | Default |
|---|
fixed_ips
optional | Fixed IP list
| any of [array[InterfaceAttachmentFixedIp], null] | |
port_id
optional | Port ID
Example : 91424c08-0b26-49fb-9808-ed042292ceef
| any of [string, null] | |
subnet_id
optional | Subnet ID
Example : 78b2ee3f074145c580ab6abac4821f97
| any of [string, null] | |
2.80 - ServerInterfaceListResponse
2.81 - ServerInterfaceListResponseV1Dot2
2.82 - ServerInterfaceUpdateRequest
| Name | Description | Schema | Default |
|---|
fixed_ip_address
optional | IP address
Example : 192.169.3.2
| any of [string, null] | |
subnet_id
optional | Subnet ID
Example :
| any of [string, null] | |
2.84 - ServerListResponse
2.85 - ServerPasswordRequest
| Name | Description | Schema | Default |
|---|
private_key
optional | Private key
Example : `—–BEGIN RSA PRIVATE KEY—– | | |
| fakeKey | | | |
—–END RSA PRIVATE KEY—–`
| any of [string, null] | | |
2.86 - ServerPasswordResponse
| Name | Description | Schema | Default |
|---|
password
optional | Server password
Example : password
| any of [string, null] | |
2.87 - ServerPrivateStaticNatCreateRequest
| Name | Description | Schema | Default |
|---|
private_nat_id
required | Private NAT ID
Example : 3a6c1dc6b1b24e02a444d672c2798a1c
| string | |
private_nat_ip_id
required | Private NAT IP ID
Example : 1f0cb5390c40483592ddc5a282f53496
| string | |
2.89 - ServerQuotaSetObject
| Name | Description | Schema | Default |
|---|
in_use
required | Quota set in use
Example : 10
| integer | |
limit
required | Quota set limit
Example : 20
| integer | |
reserved
required | Quota set reserved
Example : 0
| integer | |
2.90 - ServerRebootRequestBody
| Name | Description | Schema | Default |
|---|
reboot_type
optional | Reboot type. A SOFT reboot attempts a graceful shutdown and restart of the server. A HARD reboot attempts a forced shutdown and restart of the server. The HARD reboot corresponds to the power cycles of the server.
Example : SOFT
| any of [enum (SOFT, HARD), null] | SOFT |
2.91 - ServerSecurityGroupActionRequestBody
| Name | Description | Schema | Default |
|---|
security_group_id
required | Security Group ID
Example : c09c3f05-03d9-443f-b27a-40e0f973c75f
| string | |
2.92 - ServerSecurityGroupListResponse
2.93 - ServerSetServerTypeRequestBody
| Name | Description | Schema | Default |
|---|
server_type
required | Server type
Example : s1v1m2
| string | |
2.94 - ServerShowResponse
| Name | Description | Schema | Default |
|---|
account_id
required | Account ID
Example : a8f10467abfc4b87b64614ab36eb9ae4
| string | |
addresses
optional | Addresses
| any of [array[ServerShowResponseAddress], null] | |
auto_scaling_group_id
optional | Auto-Scaling Group ID
Example : 52613bd852b04b39adcb15a8364d856d
| any of [string, null] | |
created_at
required | Created at
Example :
| string (date-time) | |
created_by
required | Created by
Example : 97e6b22c9a4143789ca522df7457a32f
| string | |
disk_config
required | Disk config
Example : MANUAL
| string | |
id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | |
image_id
optional | Image ID
Example : 70a599e0-31e7-49b7-b260-868f441e862b
| any of [string, null] | |
is_marketplace
optional | Is Marketplace
Example : False
| any of [boolean, null] | |
keypair_name
optional | Keypair name
Example : keypairname
| any of [string, null] | |
launch_configuration_id
optional | Launch Configuration ID
Example : b5aea5a675fc4f6b9e0fcd1288354c5f
| any of [string, null] | |
locked
required | Locked
Example : False
| boolean | |
metadata
required | Metadata
Example :
| object | |
modified_at
required | Modified at
Example :
| string (date-time) | |
name
required | Server name
Example : servername
| string | |
partition_number
optional | Partition number
Example : 1
| any of [integer, null] | |
planned_compute_os_type
optional | Planned Compute OS type
Example : windows
| any of [enum (open_source, windows, rhel), null] | |
product_category
optional | Product category
Example : compute
| any of [enum (compute, container), null] | |
product_offering
optional | Product offering
Example : virtual_server
| any of [enum (virtual_server, gpu_server, k8s_vm, k8s_gpu_vm), null] | |
security_groups
optional | Security Groups
| any of [array[ServerShowResponseSecurityGroup], null] | |
server_group_id
optional | Server Group ID
Example : 616fb98f-46ca-475e-917e-2563e5a8cd19
| any of [string, null] | |
server_type
required | Server type
| ServerShowResponseServerType | |
state
required | Server state
Example : ACTIVE
| string | |
volumes
required | Volumes
| array[ServerShowResponseVolume] | |
vpc_id
optional | VPC ID
Example : cc976b621087484ea5fd527f4b78708b
| any of [string, null] | |
2.95 - ServerShowResponseAddress
2.96 - ServerShowResponseAddressIpAddress
| Name | Description | Schema | Default |
|---|
ip_address
required | IP address
Example : 192.169.3.2
| string | |
version
required | IP address version
Example : 4
| integer | |
2.97 - ServerShowResponseSecurityGroup
| Name | Description | Schema | Default |
|---|
name
required | Security Group name
Example : securitygroup
| string | |
2.98 - ServerShowResponseServerType
| Name | Description | Schema | Default |
|---|
disk
required | Size of root disk
Example : 100
| integer | |
ephemeral
required | Size of ephemeral disk
Example : 0
| integer | |
extra_specs
required | Extra specs
Example :
| object | |
id
optional | Server type ID
Example : s1v1m2
| any of [string, null] | |
name
required | Server type name
Example : s1v1m2
| string | |
ram
required | Amount of RAM
Example : 2
| integer | |
swap
required | Size of dedicated swap disk
Example : 0
| integer | |
vcpus
required | Number of CPUs
Example : 1
| integer | |
2.99 - ServerShowResponseVolume
| Name | Description | Schema | Default |
|---|
delete_on_termination
required | Delete the boot volume when the server is terminated.
Example : False
| boolean | |
id
required | Volume ID
Example : 3f500f00-ed80-4566-a057-e31760226f9a
| string | |
2.100 - ServerStaticNatCreateRequest
| Name | Description | Schema | Default |
|---|
publicip_id
required | Public IP ID
Example : 615fa9cd5cff486c9de679b3ce63e601
| string | |
2.101 - ServersVolumeResponse
| Name | Description | Schema | Default |
|---|
delete_on_termination
required | Delete the boot volume when the server is terminated.
Example : False
| boolean | |
device
required | Device name such as, /dev/vda.
Example : /dev/vda
| string | |
id
required | Volume Attachment ID
Example : 3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c
| string | |
server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | |
volume_id
required | Volume ID
Example : 3f500f00-ed80-4566-a057-e31760226f9a
| string | |
2.102 - ServerType
| Name | Description | Schema | Default |
|---|
description
required | Description
Example : description
| any of [string, null] | |
disk
required | Size of root disk
Example : 100
| integer | |
ephemeral
required | Size of ephemeral disk
Example : 0
| integer | |
extra_specs
required | Extra specs
Example :
| object | |
id
required | Server type ID
Example : s1v1m2
| string | |
name
required | Server type name
Example : s1v1m2
| string | |
ram
required | Amount of RAM
Example : 2
| integer | |
swap
required | Size of dedicated swap disk
Example : 0
| integer | |
vcpus
required | Number of CPUs
Example : 1
| integer | |
2.103 - ServerTypeListResponse
| Name | Description | Schema | Default |
|---|
server_types
required | Server type list
| array[ServerType] | |
2.104 - ServerUpdateRequest
| Name | Description | Schema | Default |
|---|
name
required | Server name
Example : servername
Pattern : ^[a-zA-Z0-9-_ ]*$
Minimum length : 1
Maximum length : 63
| string | |
2.105 - ServerVolumesCreateRequest
| Name | Description | Schema | Default |
|---|
delete_on_termination
optional | Delete the boot volume when the server is terminated.
Example : False
| any of [boolean, null] | |
device
optional | Device name such as, /dev/vda.
Example : /dev/vda
| any of [string, null] | |
volume_id
required | Volume ID
Example : 3f500f00-ed80-4566-a057-e31760226f9a
| string | |
2.106 - ServerVolumesResponse
2.107 - ServerVolumesUpdateRequest
| Name | Description | Schema | Default |
|---|
delete_on_termination
optional | Delete the boot volume when the server is terminated.
Example : False
| any of [boolean, null] | |
volume_id
required | Volume ID
Example : 3f500f00-ed80-4566-a057-e31760226f9a
| string | |
2.108 - SnapshotCreateRequest
| Name | Description | Schema | Default |
|---|
description
optional | Description
Example : description
| any of [string, null] | |
force
optional | Whether to create a snapshot even if the volume is attached
Example : True
| any of [boolean, null] | |
metadata
optional | One or more metadata key and value pairs for the snapshot
Example :
| any of [object, null] | |
name
required | Snapshot name
Example : snapshot-1
Pattern : ^[a-zA-Z0-9-_ ]+$
Maximum length : 255
| string | |
volume_id
required | Volume ID
Example : 3f500f00-ed80-4566-a057-e31760226f9a
| string | |
2.109 - SnapshotDetailResponse
| Name | Description | Schema | Default |
|---|
created_at
required | Created at
Example : 2025-07-22T09:00:00Z
| string | |
description
optional | Description
Example : description
| any of [string, null] | |
id
required | Snapshot ID
Example : cceed636-1f1e-4bb0-b85c-4e5b9e0bf790
| string | |
metadata
optional | One or more metadata key and value pairs for the snapshot
Example : Metadata
| any of [object, null] | |
name
optional | Snapshot name
Example : snapshot-1
| any of [string, null] | |
size
required | Volume size
Example : 104
| integer | |
status
optional | Volume state
Example : available
| any of [string, null] | |
updated_at
optional | Updated at
Example : 2025-07-26T12:00:00Z
| any of [string, null] | |
user_id
optional | User ID
Example : 570907805e5447be84b618450ef52o0t
| any of [string, null] | |
volume_id
required | Volume ID
Example : 3f500f00-ed80-4566-a057-e31760226f9a
| string | |
2.110 - SnapshotListResponse
| Name | Description | Schema | Default |
|---|
count
optional | Total count
Example : 100
| any of [integer, null] | |
snapshots
required | Snapshot list
| array[SnapshotDetailResponse] | |
2.111 - SnapshotUpdateRequest
| Name | Description | Schema | Default |
|---|
description
optional | Description
Example : description
| any of [string, null] | |
name
required | Snapshot name
Example : snapshot-1
Pattern : ^[a-zA-Z0-9-_ ]+$
| any of [string, null] | |
2.112 - Tag
| Name | Description | Schema | Default |
|---|
key
required | Key
Example : Key
| string | |
value
optional | Value
Example : Value
| any of [string, null] | |
2.113 - Volume
| Name | Description | Schema | Default |
|---|
boot_index
required | Defines the boot-device order. to disable a device from booting, set its index to None or a negative value.
Example : 0
| integer | |
delete_on_termination
optional | Delete the boot volume when the server is terminated.
Example : False
| any of [boolean, null] | |
size
required | Volume size, in gibibytes(GiB), must be multiple of 8.
Example : 104
| integer | |
source_type
optional | Source type of volume. blank is empty volume with no pre-loaded data. image is volume from image. if source type is not set, it defaults to ‘image’ when boot_index is 0. otherwise it defaults to ‘blank’.
Example : image
| any of [enum (blank, image), null] | |
type
optional | Volume type
Example : SSD
| any of [string, null] | |
2.114 - VolumeCreateRequest
| Name | Description | Schema | Default |
|---|
name
required | Volume name
Example : volume01
Pattern : ^[a-zA-Z0-9-_ ]*$
Minimum length : 1
Maximum length : 255
| string | |
size
required | Volume size, in gibibytes(GiB), must be multiple of 8.
Example : 104
Minimum : 8
| integer | |
snapshot_id
optional | Snapshot ID used to create the volume. when specified, request volume size must be greater than or equal to the size of the snapshot.
Example : cceed636-1f1e-4bb0-b85c-4e5b9e0bf790
| any of [string, null] | |
tags
optional | Tags
Example : [{'key': 'key', 'value': 'value'}]
| any of [array[Tag], null] | |
volume_type
optional | Sets the Volume type. if volume type is not set, the volume will be created using default type (SSD).
Example : SSD
| any of [string, null] | |
2.115 - VolumeCreateRequestV1Dot2
| Name | Description | Schema | Default |
|---|
max_iops
optional | The number of distinct read or write operations a volume can process in a single second.
Example : 10000
| any of [integer, null] | |
max_throughput
optional | The actual amount of data (volume) transferred to or from the storage device per second.
Example : 500
| any of [integer, null] | |
name
required | Volume name
Example : volume01
Pattern : ^[a-zA-Z0-9-_ ]*$
Minimum length : 1
Maximum length : 255
| string | |
size
required | Volume size, in gibibytes(GiB), must be multiple of 8.
Example : 104
Minimum : 8
| integer | |
snapshot_id
optional | Snapshot ID used to create the volume. when specified, request volume size must be greater than or equal to the size of the snapshot.
Example : cceed636-1f1e-4bb0-b85c-4e5b9e0bf790
| any of [string, null] | |
tags
optional | Tags
Example : [{'key': 'key', 'value': 'value'}]
| any of [array[Tag], null] | |
volume_type
optional | Sets the Volume type. if volume type is not set, the volume will be created using default type (SSD).
Example : SSD
| any of [string, null] | |
2.116 - VolumeExtendRequest
| Name | Description | Schema | Default |
|---|
size
required | Volume size
Example : 104
Minimum : 8
| integer | |
2.117 - VolumeImageMetadataResponse
| Name | Description | Schema | Default |
|---|
checksum
optional | MD5 hash of the entire image data. and this field could be used to verify the integrity of image.
Example : 7538e0fcb56e0e272cfd89eb384d6613
| any of [string, null] | |
container_format
optional | Container format
Example : bare
| any of [string, null] | |
disk_format
optional | Disk format
Example : qcow2
| any of [string, null] | |
image_id
optional | Image ID
Example : 70a599e0-31e7-49b7-b260-868f441e862b
| any of [string, null] | |
image_name
optional | Image name
Example : imagename
| any of [string, null] | |
min_disk
optional | Minimum disk capacity (GB) of the Image to be created
Example : 100
| any of [integer, null] | |
min_ram
optional | Minimum RAM capacity (GB) of the Image to be created
Example : 0
| any of [integer, null] | |
os_distro
optional | OS distribution of the image to be uploaded
Example : alma
| any of [string, null] | |
scp_image_type
optional | Image type
Example : custom
| any of [string, null] | |
scp_k8s_version
optional | K8S version
Example : v1.28.7
| any of [string, null] | |
scp_original_image_type
optional | Original Image type
Example : standard
| any of [string, null] | |
signature_verified
optional | Signature verified
Example : False
| any of [boolean, null] | |
size
optional | Image size
Example : 2429747200
| any of [integer, null] | |
2.118 - VolumeListResponse
| Name | Description | Schema | Default |
|---|
count
optional | Total count
Example : 100
| any of [integer, null] | |
volumes
required | Volumes
| array[VolumeShowResponse] | |
2.119 - VolumeListResponseV1Dot2
| Name | Description | Schema | Default |
|---|
count
optional | Total count
Example : 100
| any of [integer, null] | |
volumes
required | Volumes
| array[VolumeShowResponseV1Dot2] | |
2.121 - VolumeQuotaSetObject
| Name | Description | Schema | Default |
|---|
in_use
required | Quota set in use
Example : 10
| integer | |
limit
required | Quota set limit
Example :
| integer | |
reserved
required | Quota set reserved
Example : 0
| integer | |
2.122 - VolumeRevertRequest
| Name | Description | Schema | Default |
|---|
snapshot_id
required | Snapshot ID
Example : cceed636-1f1e-4bb0-b85c-4e5b9e0bf790
| string | |
2.123 - VolumeServer
| Name | Description | Schema | Default |
|---|
attached_at
required | The time when the volume was attached to the server.
Example :
| string (date-time) | |
device
required | Device name such as, /dev/vda.
Example : /dev/vda
| string | |
id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | |
2.124 - VolumeServerAttachRequest
| Name | Description | Schema | Default |
|---|
delete_on_termination
optional | Delete the boot volume when the server is terminated.
Example : False
| any of [boolean, null] | |
server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | |
2.125 - VolumeServerAttachResponse
| Name | Description | Schema | Default |
|---|
delete_on_termination
required | Delete the boot volume when the server is terminated.
Example : False
| boolean | |
device
required | Device name such as, /dev/vda.
Example : /dev/vda
| string | |
server_id
required | Server ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
| string | |
volume_id
required | Volume ID
Example : 3f500f00-ed80-4566-a057-e31760226f9a
| string | |
2.126 - VolumeSetQosRequest
| Name | Description | Schema | Default |
|---|
max_iops
optional | The number of distinct read or write operations a volume can process in a single second.
Example : 10000
| any of [integer, null] | |
max_throughput
optional | The actual amount of data (volume) transferred to or from the storage device per second.
Example : 500
| any of [integer, null] | |
2.127 - VolumeShowResponse
| Name | Description | Schema | Default |
|---|
bootable
required | Bootable
Example : False
| boolean | |
created_at
required | Created at
Example :
| string (date-time) | |
encrypted
required | Encrypted
Example : True
| boolean | |
id
required | Volume ID
Example : 3f500f00-ed80-4566-a057-e31760226f9a
| string | |
modified_at
optional | Modified at
Example : 2025-07-26T12:00:00Z
| any of [string (date-time), null] | |
multiattach
required | Connect to two or more servers, no restriction on the number of connected servers per volume, and Virtual Server can connect up to 26 volumes.
Example : False
| boolean | |
name
optional | Volume name
Example : volume01
| any of [string, null] | |
servers
required | Attached servers
| array[VolumeServer] | |
size
required | Volume size
Example : 104
| integer | |
snapshot_id
optional | Snapshot ID
Example : cceed636-1f1e-4bb0-b85c-4e5b9e0bf790
| any of [string, null] | |
state
required | Volume state
Example : available
| string | |
user_id
required | User ID
Example : 570907805e5447be84b618450ef52o0t
| string | |
volume_image_metadata
optional | Volume Image metadata
| any of [VolumeImageMetadataResponse, null] | |
volume_type
required | Volume type
Example : SSD
| string | |
volume_type_id
required | Volume type ID
Example : c643ac35-3aec-43e6-b97a-3d6f666c5207
| string | |
2.128 - VolumeShowResponseV1Dot2
| Name | Description | Schema | Default |
|---|
bootable
required | Bootable
Example : False
| boolean | |
created_at
required | Created at
Example :
| string (date-time) | |
encrypted
required | Encrypted
Example : True
| boolean | |
id
required | Volume ID
Example : 3f500f00-ed80-4566-a057-e31760226f9a
| string | |
max_iops
optional | The number of distinct read or write operations a volume can process in a single second.
Example : 10000
| any of [integer, null] | |
max_throughput
optional | The actual amount of data (volume) transferred to or from the storage device per second.
Example : 500
| any of [integer, null] | |
modified_at
optional | Modified at
Example : 2025-07-26T12:00:00Z
| any of [string (date-time), null] | |
multiattach
required | Connect to two or more servers, no restriction on the number of connected servers per volume, and Virtual Server can connect up to 26 volumes.
Example : False
| boolean | |
name
optional | Volume name
Example : volume01
| any of [string, null] | |
servers
required | Attached servers
| array[VolumeServer] | |
size
required | Volume size
Example : 104
| integer | |
snapshot_id
optional | Snapshot ID
Example : cceed636-1f1e-4bb0-b85c-4e5b9e0bf790
| any of [string, null] | |
state
required | Volume state
Example : available
| string | |
user_id
required | User ID
Example : 570907805e5447be84b618450ef52o0t
| string | |
volume_image_metadata
optional | Volume Image metadata
| any of [VolumeImageMetadataResponse, null] | |
volume_type
required | Volume type
Example : SSD
| string | |
volume_type_id
required | Volume type ID
Example : c643ac35-3aec-43e6-b97a-3d6f666c5207
| string | |
2.129 - VolumeTransferAcceptRequest
| Name | Description | Schema | Default |
|---|
auth_key
required | Auth key
Example : f5972fdb456897eb
| string | |
2.130 - VolumeTransferAcceptResponse
| Name | Description | Schema | Default |
|---|
id
required | Volume Transfer ID
Example : 1ac231be-823b-4a4d-8ff0-aac503a7118a
| string | |
name
optional | Volume name
Example : volume01
| any of [string, null] | |
volume_id
required | Volume ID
Example : 3f500f00-ed80-4566-a057-e31760226f9a
| string | |
2.131 - VolumeTransferCreateResponse
| Name | Description | Schema | Default |
|---|
auth_key
required | Auth key
Example : f5972fdb456897eb
| string | |
created_at
required | Created at
Example :
| string | |
id
required | Volume Transfer ID
Example : 1ac231be-823b-4a4d-8ff0-aac503a7118a
| string | |
name
optional | Volume name
Example : volume01
| any of [string, null] | |
volume_id
required | Volume ID
Example : 3f500f00-ed80-4566-a057-e31760226f9a
| string | |
2.132 - VolumeTransferListResponse
2.133 - VolumeTransferRequest
| Name | Description | Schema | Default |
|---|
name
optional | Volume name
Example : volume01
| any of [string, null] | |
volume_id
required | Volume ID
Example : 3f500f00-ed80-4566-a057-e31760226f9a
| string | |
2.134 - VolumeTransferShowResponse
| Name | Description | Schema | Default |
|---|
created_at
required | Created at
Example : 2025-07-22T09:00:00Z
| string | |
id
required | Volume Transfer ID
Example : 1ac231be-823b-4a4d-8ff0-aac503a7118a
| string | |
name
optional | Volume name
Example : volume01
| any of [string, null] | |
volume_id
required | Volume ID
Example : 3f500f00-ed80-4566-a057-e31760226f9a
| string | |
2.135 - VolumeTypeDetailResponse
| Name | Description | Schema | Default |
|---|
description
optional | Volume type description
Example : Volume type description
| any of [string, null] | |
extra_specs
optional | Extra specs
| any of [VolumeTypeExtraSpecs, null] | |
id
required | Volume type ID
Example : c643ac35-3aec-43e6-b97a-3d6f666c5207
| string | |
name
optional | Volume type name
Example : SSD
| any of [string, null] | |
2.136 - VolumeTypeExtraSpecs
| Name | Description | Schema | Default |
|---|
multiattach
optional | Multiattach
Example : <is> True
| any of [string, null] | |
2.137 - VolumeTypeListResponse
2.138 - VolumeUpdateRequest
| Name | Description | Schema | Default |
|---|
name
optional | Volume name
Example : volume01
Pattern : ^[a-zA-Z0-9-_ ]*$
| any of [string, null] | |
2.139 - VolumeV1Dot2
| Name | Description | Schema | Default |
|---|
boot_index
required | Defines the boot-device order. to disable a device from booting, set its index to None or a negative value.
Example : 0
| integer | |
delete_on_termination
optional | Delete the boot volume when the server is terminated.
Example : False
| any of [boolean, null] | |
max_iops
optional | The number of distinct read or write operations a volume can process in a single second.
Example : 10000
| any of [integer, null] | |
max_throughput
optional | The actual amount of data (volume) transferred to or from the storage device per second.
Example : 500
| any of [integer, null] | |
size
required | Volume size, in gibibytes(GiB), must be multiple of 8.
Example : 104
| integer | |
source_type
optional | Source type of volume. blank is empty volume with no pre-loaded data. image is volume from image. if source type is not set, it defaults to ‘image’ when boot_index is 0. otherwise it defaults to ‘blank’.
Example : image
| any of [enum (blank, image), null] | |
type
optional | Volume type
Example : SSD
| any of [string, null] | |