This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Models

1: AutoScalingGroup
2: AutoScalingGroupCreateRequest
3: AutoScalingGroupCreateRequestV1Dot2
4: AutoScalingGroupLbServerGroup
5: AutoScalingGroupLbServerGroupListResponse
6: AutoScalingGroupLbServerGroupSetRequest
7: AutoScalingGroupLbServerGroupShowResponse
8: AutoScalingGroupListResponse
9: AutoScalingGroupListResponseV1Dot2
10: AutoScalingGroupNotificationCreateRequest
11: AutoScalingGroupNotificationListResponse
12: AutoScalingGroupNotificationShowResponse
13: AutoScalingGroupNotificationUpdateRequest
14: AutoScalingGroupPolicyCreateRequest
15: AutoScalingGroupPolicyListResponse
16: AutoScalingGroupPolicyShowResponse
17: AutoScalingGroupPolicyUpdateRequest
18: AutoScalingGroupPolicyUpdateRequestV1Dot2
19: AutoScalingGroupScheduleCreateRequest
20: AutoScalingGroupScheduleListResponse
21: AutoScalingGroupScheduleShowResponse
22: AutoScalingGroupScheduleUpdateRequest
23: AutoScalingGroupSetRequest
24: AutoScalingGroupSetRequestV1Dot2
25: AutoScalingGroupSetServerCountRequest
26: AutoScalingGroupShowResponse
27: AutoScalingGroupShowResponseV1Dot2
28: AutoScalingGroupV1Dot2
29: AutoScalingGroupVirtualServerListResponse
30: AutoScalingGroupVirtualServerListResponseV1Dot2
31: AutoScalingGroupVirtualServerShowResponse
32: AutoScalingGroupVirtualServerShowResponseV1Dot2
33: DefaultConfigListResponse
34: ImageCreateRequest
35: ImageImportRequest
36: ImageListResponse
37: ImageListResponseV1Dot2
38: ImageMemberCreateRequest
39: ImageMemberListResponse
40: ImageMemberSetRequest
41: ImageMemberShowResponse
42: ImageSetRequest
43: ImageShowResponse
44: ImageShowResponseV1Dot2
45: InterfaceAttachmentFixedIp
46: InterfaceResponse
47: InterfaceResponseV1Dot2
48: Keypair
49: KeypairCreateRequest
50: KeypairCreateResponse
51: KeypairListResponse
52: KeypairShowResponse
53: LaunchConfigurationCreateRequest
54: LaunchConfigurationDetailShowResponse
55: LaunchConfigurationDetailShowResponseV1Dot2
56: LaunchConfigurationListResponse
57: LaunchConfigurationListResponseV1Dot2
58: LaunchConfigurationShowResponse
59: LaunchConfigurationShowResponseV1Dot2
60: LaunchConfigurationVolume
61: LaunchConfigurationVolumeV1Dot2
62: Network
63: PrivateStaticNat
64: PublicStaticNat
65: SecurityGroupResponse
66: SecurityGroupResponseRule
67: SecurityGroupResponseRuleIpRange
68: ServerConsoleLogResponse
69: ServerCreateImageRequestBody
70: ServerCreateImageResponse
71: ServerCreateRequest
72: ServerCreateRequestV1Dot2
73: ServerCreateResponse
74: ServerCreateResponseParam
75: ServerGroup
76: ServerGroupCreateRequest
77: ServerGroupListResponse
78: ServerGroupPartitionSizeResponse
79: ServerInterfaceCreateRequest
80: ServerInterfaceListResponse
81: ServerInterfaceListResponseV1Dot2
82: ServerInterfaceUpdateRequest
83: ServerIpsResponse
84: ServerListResponse
85: ServerPasswordRequest
86: ServerPasswordResponse
87: ServerPrivateStaticNatCreateRequest
88: ServerQuotaSet
89: ServerQuotaSetObject
90: ServerRebootRequestBody
91: ServerSecurityGroupActionRequestBody
92: ServerSecurityGroupListResponse
93: ServerSetServerTypeRequestBody
94: ServerShowResponse
95: ServerShowResponseAddress
96: ServerShowResponseAddressIpAddress
97: ServerShowResponseSecurityGroup
98: ServerShowResponseServerType
99: ServerShowResponseVolume
100: ServerStaticNatCreateRequest
101: ServersVolumeResponse
102: ServerType
103: ServerTypeListResponse
104: ServerUpdateRequest
105: ServerVolumesCreateRequest
106: ServerVolumesResponse
107: ServerVolumesUpdateRequest
108: SnapshotCreateRequest
109: SnapshotDetailResponse
110: SnapshotListResponse
111: SnapshotUpdateRequest
112: Tag
113: Volume
114: VolumeCreateRequest
115: VolumeCreateRequestV1Dot2
116: VolumeExtendRequest
117: VolumeImageMetadataResponse
118: VolumeListResponse
119: VolumeListResponseV1Dot2
120: VolumeQuotaSet
121: VolumeQuotaSetObject
122: VolumeRevertRequest
123: VolumeServer
124: VolumeServerAttachRequest
125: VolumeServerAttachResponse
126: VolumeSetQosRequest
127: VolumeShowResponse
128: VolumeShowResponseV1Dot2
129: VolumeTransferAcceptRequest
130: VolumeTransferAcceptResponse
131: VolumeTransferCreateResponse
132: VolumeTransferListResponse
133: VolumeTransferRequest
134: VolumeTransferShowResponse
135: VolumeTypeDetailResponse
136: VolumeTypeExtraSpecs
137: VolumeTypeListResponse
138: VolumeUpdateRequest
139: VolumeV1Dot2

1 - AutoScalingGroup

Name	Description	Schema
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 - AutoScalingGroupCreateRequest

Name	Description	Schema
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]

3 - AutoScalingGroupCreateRequestV1Dot2

Name	Description	Schema
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

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

5 - AutoScalingGroupLbServerGroupListResponse

Name	Description	Schema	Default
count required	count Example : `20`	integer
lb_server_groups required	LB Server Group list	array[AutoScalingGroupLbServerGroupShowResponse]

6 - AutoScalingGroupLbServerGroupSetRequest

Name	Description	Schema	Default
lb_server_groups required	LB Server Group list	array[AutoScalingGroupLbServerGroup]

7 - AutoScalingGroupLbServerGroupShowResponse

Name	Description	Schema
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

8 - AutoScalingGroupListResponse

Name	Description	Schema	Default
auto_scaling_groups required	Auto-Scaling Group list	array[AutoScalingGroup]
count required	count Example : `20`	integer

9 - AutoScalingGroupListResponseV1Dot2

Name	Description	Schema	Default
auto_scaling_groups required	Auto-Scaling Group list	array[AutoScalingGroupV1Dot2]
count required	count Example : `20`	integer

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]

11 - AutoScalingGroupNotificationListResponse

Name	Description	Schema	Default
count required	count Example : `20`	integer
notifications required	Auto-Scaling Group notification list	array[AutoScalingGroupNotificationShowResponse]

12 - AutoScalingGroupNotificationShowResponse

Name	Description	Schema
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

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]

14 - AutoScalingGroupPolicyCreateRequest

Name	Description	Schema
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

15 - AutoScalingGroupPolicyListResponse

Name	Description	Schema	Default
count required	count Example : `20`	integer
policies required		array[AutoScalingGroupPolicyShowResponse]

16 - AutoScalingGroupPolicyShowResponse

Name	Description	Schema
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

17 - AutoScalingGroupPolicyUpdateRequest

Name	Description	Schema
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]

18 - AutoScalingGroupPolicyUpdateRequestV1Dot2

Name	Description	Schema
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]

19 - AutoScalingGroupScheduleCreateRequest

Name	Description	Schema
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

20 - AutoScalingGroupScheduleListResponse

Name	Description	Schema
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]

21 - AutoScalingGroupScheduleShowResponse

Name	Description	Schema
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

22 - AutoScalingGroupScheduleUpdateRequest

Name	Description	Schema
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]

23 - AutoScalingGroupSetRequest

Name	Description	Schema
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]

24 - AutoScalingGroupSetRequestV1Dot2

Name	Description	Schema
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]

25 - AutoScalingGroupSetServerCountRequest

Name	Description	Schema
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]

26 - AutoScalingGroupShowResponse

Name	Description	Schema
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

27 - AutoScalingGroupShowResponseV1Dot2

Name	Description	Schema
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

28 - AutoScalingGroupV1Dot2

Name	Description	Schema
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

29 - AutoScalingGroupVirtualServerListResponse

Name	Description	Schema	Default
servers required	Server list	array[AutoScalingGroupVirtualServerShowResponse]

30 - AutoScalingGroupVirtualServerListResponseV1Dot2

Name	Description	Schema	Default
servers required	Server list	array[AutoScalingGroupVirtualServerShowResponseV1Dot2]

31 - AutoScalingGroupVirtualServerShowResponse

Name	Description	Schema
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]

32 - AutoScalingGroupVirtualServerShowResponseV1Dot2

Name	Description	Schema
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]

33 - DefaultConfigListResponse

Name	Description	Schema	Default
configs required	Configs Example : `('key': 'value'}`	object
count required	count Example : `20`	integer

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

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

36 - ImageListResponse

Name	Description	Schema	Default
images required		array[ImageShowResponse]

37 - ImageListResponseV1Dot2

Name	Description	Schema	Default
images required		array[ImageShowResponseV1Dot2]

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

39 - ImageMemberListResponse

Name	Description	Schema	Default
members required		array[ImageMemberShowResponse]

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)

41 - ImageMemberShowResponse

Name	Description	Schema
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

42 - ImageSetRequest

Name	Description	Schema
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]

43 - ImageShowResponse

Name	Description	Schema
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]

44 - ImageShowResponseV1Dot2

Name	Description	Schema
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]

45 - InterfaceAttachmentFixedIp

Name	Description	Schema	Default
ip_address required	IP address Example : `192.169.3.2`	string

46 - InterfaceResponse

Name	Description	Schema
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

47 - InterfaceResponseV1Dot2

Name	Description	Schema
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

48 - Keypair

Name	Description	Schema
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

49 - KeypairCreateRequest

Name	Description	Schema
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]

50 - KeypairCreateResponse

Name	Description	Schema
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

51 - KeypairListResponse

Name	Description	Schema	Default
keypairs required		array[Keypair]

52 - KeypairShowResponse

Name	Description	Schema
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

53 - LaunchConfigurationCreateRequest

Name	Description	Schema
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]

54 - LaunchConfigurationDetailShowResponse

Name	Description	Schema
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]

55 - LaunchConfigurationDetailShowResponseV1Dot2

Name	Description	Schema
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]

56 - LaunchConfigurationListResponse

Name	Description	Schema	Default
count optional	count Example : `20`	integer
launch_configurations required	Launch Configuration list	array[LaunchConfigurationShowResponse]

57 - LaunchConfigurationListResponseV1Dot2

Name	Description	Schema	Default
count optional	count Example : `20`	integer
launch_configurations required	Launch Configuration list	array[LaunchConfigurationShowResponseV1Dot2]

58 - LaunchConfigurationShowResponse

Name	Description	Schema
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]

59 - LaunchConfigurationShowResponseV1Dot2

Name	Description	Schema
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]

60 - LaunchConfigurationVolume

Name	Description	Schema
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]

61 - LaunchConfigurationVolumeV1Dot2

Name	Description	Schema
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]

62 - Network

Name	Description	Schema
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]

63 - PrivateStaticNat

Name	Description	Schema
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

64 - PublicStaticNat

Name	Description	Schema
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

65 - SecurityGroupResponse

Name	Description	Schema
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]

66 - SecurityGroupResponseRule

Name	Description	Schema
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]

67 - SecurityGroupResponseRuleIpRange

Name	Description	Schema	Default
cidr optional	CIDR Example : `0.0.0.0/0`	any of [string, null]

68 - ServerConsoleLogResponse

Name	Description	Schema	Default
output optional	Server console log output Example : `FAKE CONSOLE OUTPUT`	any of [string, null]

69 - ServerCreateImageRequestBody

Name	Description	Schema	Default
image_name required	Image name Example : `imagename`	string

70 - ServerCreateImageResponse

Name	Description	Schema	Default
image_id required	Image ID Example : `70a599e0-31e7-49b7-b260-868f441e862b`	string

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]

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]

73 - ServerCreateResponse

Name	Description	Schema	Default
servers required	Server ID list	array[ServerCreateResponseParam]

74 - ServerCreateResponseParam

Name	Description	Schema	Default
id required	Server ID Example : `2a9be312-5d4b-4bc8-b2ae-35100fa9241f`	string

75 - ServerGroup

Name	Description	Schema
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

76 - ServerGroupCreateRequest

Name	Description	Schema
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]

77 - ServerGroupListResponse

Name	Description	Schema	Default
server_groups required	Server Group list	array[ServerGroup]

78 - ServerGroupPartitionSizeResponse

Name	Description	Schema	Default
partition_size required	Example :	integer

79 - ServerInterfaceCreateRequest

Name	Description	Schema
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]

80 - ServerInterfaceListResponse

Name	Description	Schema	Default
interfaces required	Interface List	array[InterfaceResponse]

81 - ServerInterfaceListResponseV1Dot2

Name	Description	Schema	Default
interfaces required	Interface List	array[InterfaceResponseV1Dot2]

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]

83 - ServerIpsResponse

Name	Description	Schema	Default
addresses required	IP addresses	array[ServerShowResponseAddress]

84 - ServerListResponse

Name	Description	Schema	Default
servers required	Server list	array[ServerShowResponse]

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]

86 - ServerPasswordResponse

Name	Description	Schema	Default
password optional	Server password Example : `password`	any of [string, null]

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

88 - ServerQuotaSet

Name	Description	Schema
cores required	Core quota	ServerQuotaSetObject
id required	Quota set ID Example : `fc7283354c6143a58629b59f4c3e16b2`	string
instances required	Instance quota	ServerQuotaSetObject
keypairs required	Keypairs quota	ServerQuotaSetObject
metadata_items required	Metadata items quota	ServerQuotaSetObject
ram required	RAM quota	ServerQuotaSetObject
server_group_members required	Server group members quota	ServerQuotaSetObject
server_groups required	Server groups quota	ServerQuotaSetObject

89 - ServerQuotaSetObject

Name	Description	Schema
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

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

91 - ServerSecurityGroupActionRequestBody

Name	Description	Schema	Default
security_group_id required	Security Group ID Example : `c09c3f05-03d9-443f-b27a-40e0f973c75f`	string

92 - ServerSecurityGroupListResponse

Name	Description	Schema	Default
security_groups required	Security Groups	array[SecurityGroupResponse]

93 - ServerSetServerTypeRequestBody

Name	Description	Schema	Default
server_type required	Server type Example : `s1v1m2`	string

94 - ServerShowResponse

Name	Description	Schema
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]

95 - ServerShowResponseAddress

Name	Description	Schema	Default
ip_addresses required	IP addresses	array[ServerShowResponseAddressIpAddress]
subnet_name required	Subnet name Example : `subnetname`	string

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

97 - ServerShowResponseSecurityGroup

Name	Description	Schema	Default
name required	Security Group name Example : `securitygroup`	string

98 - ServerShowResponseServerType

Name	Description	Schema
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

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

100 - ServerStaticNatCreateRequest

Name	Description	Schema	Default
publicip_id required	Public IP ID Example : `615fa9cd5cff486c9de679b3ce63e601`	string

101 - ServersVolumeResponse

Name	Description	Schema
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

102 - ServerType

Name	Description	Schema
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

103 - ServerTypeListResponse

Name	Description	Schema	Default
server_types required	Server type list	array[ServerType]

104 - ServerUpdateRequest

Name	Description	Schema	Default
name required	Server name Example : `servername` Pattern : `^[a-zA-Z0-9-_ ]$` Minimum length* : `1` Maximum length : `63`	string

105 - ServerVolumesCreateRequest

Name	Description	Schema
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

106 - ServerVolumesResponse

Name	Description	Schema	Default
volumes required	Volumes	array[ServersVolumeResponse]

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

108 - SnapshotCreateRequest

Name	Description	Schema
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

109 - SnapshotDetailResponse

Name	Description	Schema
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

110 - SnapshotListResponse

Name	Description	Schema	Default
count optional	Total count Example : `100`	any of [integer, null]
snapshots required	Snapshot list	array[SnapshotDetailResponse]

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]

112 - Tag

Name	Description	Schema	Default
key required	Key Example : `Key`	string
value optional	Value Example : `Value`	any of [string, null]

113 - Volume

Name	Description	Schema
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]

114 - VolumeCreateRequest

Name	Description	Schema
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]

115 - VolumeCreateRequestV1Dot2

Name	Description	Schema
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]

116 - VolumeExtendRequest

Name	Description	Schema	Default
size required	Volume size Example : `104` Minimum : `8`	integer

117 - VolumeImageMetadataResponse

Name	Description	Schema
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]

118 - VolumeListResponse

Name	Description	Schema	Default
count optional	Total count Example : `100`	any of [integer, null]
volumes required	Volumes	array[VolumeShowResponse]

119 - VolumeListResponseV1Dot2

Name	Description	Schema	Default
count optional	Total count Example : `100`	any of [integer, null]
volumes required	Volumes	array[VolumeShowResponseV1Dot2]

120 - VolumeQuotaSet

Name	Description	Schema
id required	Quota set ID Example : `fc7283354c6143a58629b59f4c3e16b2`	string
per_volume_size required	Per volume size quota	VolumeQuotaSetObject
snapshots required	Snapshot Quota	VolumeQuotaSetObject
usages required	Usage quota	VolumeQuotaSetObject
volumes required	Volume Quota	VolumeQuotaSetObject

121 - VolumeQuotaSetObject

Name	Description	Schema
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

122 - VolumeRevertRequest

Name	Description	Schema	Default
snapshot_id required	Snapshot ID Example : `cceed636-1f1e-4bb0-b85c-4e5b9e0bf790`	string

123 - VolumeServer

Name	Description	Schema
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

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

125 - VolumeServerAttachResponse

Name	Description	Schema
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

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]

127 - VolumeShowResponse

Name	Description	Schema
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

128 - VolumeShowResponseV1Dot2

Name	Description	Schema
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

129 - VolumeTransferAcceptRequest

Name	Description	Schema	Default
auth_key required	Auth key Example : `f5972fdb456897eb`	string

130 - VolumeTransferAcceptResponse

Name	Description	Schema
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

131 - VolumeTransferCreateResponse

Name	Description	Schema
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

132 - VolumeTransferListResponse

Name	Description	Schema	Default
transfers required	Volume Transfer List	array[VolumeTransferAcceptResponse]

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

134 - VolumeTransferShowResponse

Name	Description	Schema
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

135 - VolumeTypeDetailResponse

Name	Description	Schema
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]

136 - VolumeTypeExtraSpecs

Name	Description	Schema	Default
multiattach optional	Multiattach Example : `<is> True`	any of [string, null]

137 - VolumeTypeListResponse

Name	Description	Schema	Default
volume_types required	Volume type list	array[VolumeTypeDetailResponse]

138 - VolumeUpdateRequest

Name	Description	Schema	Default
name optional	Volume name Example : `volume01` Pattern : `^[a-zA-Z0-9-_ ]*$`	any of [string, null]

139 - VolumeV1Dot2

Name	Description	Schema
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]