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

Return to the regular view of this page.

APIs

1: Accept a volume transfer

1.1: 1.3
1.2: 1.2
1.3: 1.1
1.4: 1.0

2: Attach Virtual Server Security Group

2.1: 1.0

3: Attach Volume to Virtual Server

3.1: 1.3
3.2: 1.2
3.3: 1.1
3.4: 1.0

4: Create a snapshot

4.1: 1.3
4.2: 1.2
4.3: 1.1
4.4: 1.0

5: Create a volume transfer

5.1: 1.3
5.2: 1.2
5.3: 1.1
5.4: 1.0

6: Create Auto-Scaling Group

6.1: 1.3
6.2: 1.2
6.3: 1.1
6.4: 1.0

7: Create Auto-Scaling Group Notification

7.1: 1.3
7.2: 1.2
7.3: 1.1
7.4: 1.0

8: Create Auto-Scaling Group Policy

8.1: 1.3
8.2: 1.2
8.3: 1.1
8.4: 1.0

9: Create Auto-Scaling Group Schedule

9.1: 1.3
9.2: 1.2
9.3: 1.1
9.4: 1.0

10: Create Image

10.1: 1.3
10.2: 1.2
10.3: 1.1
10.4: 1.0

11: Create Image member

11.1: 1.3
11.2: 1.2
11.3: 1.1
11.4: 1.0

12: Create Keypair

12.1: 1.3
12.2: 1.2
12.3: 1.1
12.4: 1.0

13: Create Launch Configuration

13.1: 1.3
13.2: 1.2
13.3: 1.1
13.4: 1.0

14: Create Server Group

14.1: 1.3
14.2: 1.2
14.3: 1.1
14.4: 1.0

15: Create Server Interface

15.1: 1.3
15.2: 1.2
15.3: 1.1
15.4: 1.0

16: Create Server Interface Nat

16.1: 1.3
16.2: 1.2
16.3: 1.1
16.4: 1.0

17: Create Server Interface Private Nat

17.1: 1.3
17.2: 1.2
17.3: 1.1
17.4: 1.0

18: Create Server Volume

18.1: 1.3
18.2: 1.2
18.3: 1.1
18.4: 1.0

19: Create Sharing Image

19.1: 1.3
19.2: 1.2
19.3: 1.1
19.4: 1.0

20: Create Virtual Server

20.1: 1.3
20.2: 1.2
20.3: 1.1
20.4: 1.0

21: Create Virtual Server Custom Image

21.1: 1.3
21.2: 1.2
21.3: 1.1
21.4: 1.0

22: Create Virtual Server Dump

22.1: 1.3
22.2: 1.2
22.3: 1.1
22.4: 1.0

23: Create Volume

23.1: 1.3
23.2: 1.2
23.3: 1.1
23.4: 1.0

24: Delete a snapshot

24.1: 1.3
24.2: 1.2
24.3: 1.1
24.4: 1.0

25: Delete a volume transfer

25.1: 1.3
25.2: 1.2
25.3: 1.1
25.4: 1.0

26: Delete Auto-Scaling Group

26.1: 1.3
26.2: 1.2
26.3: 1.1
26.4: 1.0

27: Delete Auto-Scaling Group Notification

27.1: 1.3
27.2: 1.2
27.3: 1.1
27.4: 1.0

28: Delete Auto-Scaling Group Policy

28.1: 1.3
28.2: 1.2
28.3: 1.1
28.4: 1.0

29: Delete Auto-Scaling Group Schedule

29.1: 1.3
29.2: 1.2
29.3: 1.1
29.4: 1.0

30: Delete Image

30.1: 1.3
30.2: 1.2
30.3: 1.1
30.4: 1.0

31: Delete Image member

31.1: 1.3
31.2: 1.2
31.3: 1.1
31.4: 1.0

32: Delete Keypair

32.1: 1.3
32.2: 1.2
32.3: 1.1
32.4: 1.0

33: Delete Launch Configuration

33.1: 1.3
33.2: 1.2
33.3: 1.1
33.4: 1.0

34: Delete Server Group

34.1: 1.3
34.2: 1.2
34.3: 1.1
34.4: 1.0

35: Delete Server Interface

35.1: 1.3
35.2: 1.2
35.3: 1.1
35.4: 1.0

36: Delete Server Interface Nat

36.1: 1.3
36.2: 1.2
36.3: 1.1
36.4: 1.0

37: Delete Server Interface Private Nat

37.1: 1.3
37.2: 1.2
37.3: 1.1
37.4: 1.0

38: Delete Server Volume

38.1: 1.3
38.2: 1.2
38.3: 1.1
38.4: 1.0

39: Delete Virtual Server

39.1: 1.3
39.2: 1.2
39.3: 1.1
39.4: 1.0

40: Delete Volume

40.1: 1.3
40.2: 1.2
40.3: 1.1
40.4: 1.0

41: Detach Virtual Server Security Group

41.1: 1.0

42: Detach Volume from Virtual Server

42.1: 1.3
42.2: 1.2
42.3: 1.1
42.4: 1.0

43: Extend Volume

43.1: 1.3
43.2: 1.2
43.3: 1.1
43.4: 1.0

44: Get region's maximum partition size.

44.1: 1.3
44.2: 1.2
44.3: 1.1
44.4: 1.0

45: Import Image

45.1: 1.3
45.2: 1.2
45.3: 1.1
45.4: 1.0

46: List Auto-Scaling Group LB Server Groups

46.1: 1.3
46.2: 1.2
46.3: 1.1
46.4: 1.0

47: List Auto-Scaling Group Notifications

47.1: 1.3
47.2: 1.2
47.3: 1.1
47.4: 1.0

48: List Auto-Scaling Group Policies

48.1: 1.3
48.2: 1.2
48.3: 1.1
48.4: 1.0

49: List Auto-Scaling Group Schedules

49.1: 1.3
49.2: 1.2
49.3: 1.1
49.4: 1.0

50: List Auto-Scaling Group Virtual Servers

50.1: 1.3
50.2: 1.2
50.3: 1.1
50.4: 1.0

51: List Auto-Scaling Groups

51.1: 1.3
51.2: 1.2
51.3: 1.1
51.4: 1.0

52: List Default Configs

52.1: 1.3
52.2: 1.2
52.3: 1.1
52.4: 1.0

53: List Image members

53.1: 1.3
53.2: 1.2
53.3: 1.1
53.4: 1.0

54: List Images

54.1: 1.3
54.2: 1.2
54.3: 1.1
54.4: 1.0

55: List Keypairs

55.1: 1.3
55.2: 1.2
55.3: 1.1
55.4: 1.0

56: List Launch Configurations

56.1: 1.3
56.2: 1.2
56.3: 1.1
56.4: 1.0

57: List pending Images

57.1: 1.3
57.2: 1.2
57.3: 1.1
57.4: 1.0

58: List Server Groups

58.1: 1.3
58.2: 1.2
58.3: 1.1
58.4: 1.0

59: List Server Interfaces

59.1: 1.3
59.2: 1.2
59.3: 1.1
59.4: 1.0

60: List Server Ips

60.1: 1.3
60.2: 1.2
60.3: 1.1
60.4: 1.0

61: List Server Types

61.1: 1.3
61.2: 1.2
61.3: 1.1
61.4: 1.0

62: List Server Volumes

62.1: 1.3
62.2: 1.2
62.3: 1.1
62.4: 1.0

63: List snapshots

63.1: 1.3
63.2: 1.2
63.3: 1.1
63.4: 1.0

64: List Virtual Server Security Group

64.1: 1.3
64.2: 1.2
64.3: 1.1
64.4: 1.0

65: List Virtual Servers

65.1: 1.3
65.2: 1.2
65.3: 1.1
65.4: 1.0

66: List volume transfers

66.1: 1.3
66.2: 1.2
66.3: 1.1
66.4: 1.0

67: List volume types

67.1: 1.3
67.2: 1.2
67.3: 1.1
67.4: 1.0

68: List volumes

68.1: 1.3
68.2: 1.2
68.3: 1.1
68.4: 1.0

69: Lock Virtual Server

69.1: 1.3
69.2: 1.2
69.3: 1.1
69.4: 1.0

70: Reboot Virtual Server

70.1: 1.3
70.2: 1.2
70.3: 1.1
70.4: 1.0

71: Rebuild Virtual Server

71.1: 1.3
71.2: 1.2
71.3: 1.1
71.4: 1.0

72: Revert Volume to snapshot

72.1: 1.3
72.2: 1.2
72.3: 1.1
72.4: 1.0

73: Set Volume Qos

73.1: 1.3
73.2: 1.2

74: Show a snapshot’s details

74.1: 1.3
74.2: 1.2
74.3: 1.1
74.4: 1.0

75: Show Auto-Scaling Group

75.1: 1.3
75.2: 1.2
75.3: 1.1
75.4: 1.0

76: Show Auto-Scaling Group Notification

76.1: 1.3
76.2: 1.2
76.3: 1.1
76.4: 1.0

77: Show Auto-Scaling Group Policy

77.1: 1.3
77.2: 1.2
77.3: 1.1
77.4: 1.0

78: Show Auto-Scaling Group Schedule

78.1: 1.3
78.2: 1.2
78.3: 1.1
78.4: 1.0

79: Show default Volume type’s details

79.1: 1.3
79.2: 1.2
79.3: 1.1
79.4: 1.0

80: Show Image

80.1: 1.3
80.2: 1.2
80.3: 1.1
80.4: 1.0

81: Show Image member

81.1: 1.3
81.2: 1.2
81.3: 1.1
81.4: 1.0

82: Show Keypair

82.1: 1.3
82.2: 1.2
82.3: 1.1
82.4: 1.0

83: Show Launch Configuration

83.1: 1.3
83.2: 1.2
83.3: 1.1
83.4: 1.0

84: Show Server Group

84.1: 1.3
84.2: 1.2
84.3: 1.1
84.4: 1.0

85: Show Server Interface

85.1: 1.3
85.2: 1.2
85.3: 1.1
85.4: 1.0

86: Show Server Ip

86.1: 1.3
86.2: 1.2
86.3: 1.1
86.4: 1.0

87: Show Server Quota Set

87.1: 1.3
87.2: 1.2
87.3: 1.1
87.4: 1.0

88: Show Server Type

88.1: 1.3
88.2: 1.2
88.3: 1.1
88.4: 1.0

89: Show Server Volume

89.1: 1.3
89.2: 1.2
89.3: 1.1
89.4: 1.0

90: Show Virtual Server

90.1: 1.3
90.2: 1.2
90.3: 1.1
90.4: 1.0

91: Show Virtual Server Console Log

91.1: 1.3
91.2: 1.2
91.3: 1.1
91.4: 1.0

92: Show Virtual Server Password

92.1: 1.3
92.2: 1.2
92.3: 1.1
92.4: 1.0

93: Show Volume Quota Set

93.1: 1.3
93.2: 1.2
93.3: 1.1
93.4: 1.0

94: Show volume transfer detail

94.1: 1.3
94.2: 1.2
94.3: 1.1
94.4: 1.0

95: Show Volume type’s details

95.1: 1.3
95.2: 1.2
95.3: 1.1
95.4: 1.0

96: Show Volume's details

96.1: 1.3
96.2: 1.2
96.3: 1.1
96.4: 1.0

97: Start Virtual Server

97.1: 1.3
97.2: 1.2
97.3: 1.1
97.4: 1.0

98: Stop Virtual Server

98.1: 1.3
98.2: 1.2
98.3: 1.1
98.4: 1.0

99: Unlock Virtual Server

99.1: 1.3
99.2: 1.2
99.3: 1.1
99.4: 1.0

100: Update a snapshot

100.1: 1.3
100.2: 1.2
100.3: 1.1
100.4: 1.0

101: Update Auto-Scaling Group

101.1: 1.3
101.2: 1.2
101.3: 1.1
101.4: 1.0

102: Update Auto-Scaling Group LB Server Groups

102.1: 1.3
102.2: 1.2
102.3: 1.1
102.4: 1.0

103: Update Auto-Scaling Group Notification

103.1: 1.3
103.2: 1.2
103.3: 1.1
103.4: 1.0

104: Update Auto-Scaling Group Policy

104.1: 1.3
104.2: 1.2
104.3: 1.1
104.4: 1.0

105: Update Auto-Scaling Group Schedule

105.1: 1.3
105.2: 1.2
105.3: 1.1
105.4: 1.0

106: Update Auto-Scaling Group server count

106.1: 1.3
106.2: 1.2
106.3: 1.1
106.4: 1.0

107: Update Image

107.1: 1.3
107.2: 1.2
107.3: 1.1
107.4: 1.0

108: Update Image member

108.1: 1.3
108.2: 1.2
108.3: 1.1
108.4: 1.0

109: Update Server Interface

109.1: 1.3
109.2: 1.2
109.3: 1.1
109.4: 1.0

110: Update Server Volume

110.1: 1.3
110.2: 1.2
110.3: 1.1
110.4: 1.0

111: Update Virtual Server

111.1: 1.3
111.2: 1.2
111.3: 1.1
111.4: 1.0

112: Update Virtual Server type

112.1: 1.3
112.2: 1.2
112.3: 1.1
112.4: 1.0

113: Update Volume

113.1: 1.3
113.2: 1.2
113.3: 1.1
113.4: 1.0

1 - Accept a volume transfer

1.1 - 1.3

post /v1/volume-transfer/{transfer_id}/accept

Description

Accept a volume transfer.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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

HTTP Code	Description	Schema
202	Accepted	VolumeTransferAcceptResponse
400	Bad Request	None
401	Unauthorized	None

Example HTTP request

Request path

/v1/volume-transfer/{transfer_id}/accept

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

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 - 1.2

post /v1/volume-transfer/{transfer_id}/accept

Description

Accept a volume transfer.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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

HTTP Code	Description	Schema
202	Accepted	VolumeTransferAcceptResponse
400	Bad Request	None
401	Unauthorized	None

Example HTTP request

Request path

/v1/volume-transfer/{transfer_id}/accept

Request header

"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.3 - 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

HTTP Code	Description	Schema
202	Accepted	VolumeTransferAcceptResponse
400	Bad Request	None
401	Unauthorized	None

Example HTTP request

Request path

/v1/volume-transfer/{transfer_id}/accept

Request header

"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.4 - 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

HTTP Code	Description	Schema
202	Accepted	VolumeTransferAcceptResponse
400	Bad Request	None
401	Unauthorized	None

Example HTTP request

Request path

/v1/volume-transfer/{transfer_id}/accept

Request header

"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"
}

2 - Attach Virtual Server Security Group

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

Type	Name	Description	Schema	Default
path	server_id required	Server ID Example : `2a9be312-5d4b-4bc8-b2ae-35100fa9241f`	string	None
body	body required		ServerSecurityGroupActionRequestBody

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

Request header

"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

3 - Attach Volume to Virtual Server

3.1 - 1.3

post /v1/volumes/{volume_id}/servers

Description

Attach Volume to Virtual Server.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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

HTTP Code	Description	Schema
202	Accepted	VolumeServerAttachResponse
400	Bad Request	None
401	Unauthorized	None
409	Conflict	None

Example HTTP request

Request path

/v1/volumes/{volume_id}/servers

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

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"
}

3.2 - 1.2

post /v1/volumes/{volume_id}/servers

Description

Attach Volume to Virtual Server.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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

HTTP Code	Description	Schema
202	Accepted	VolumeServerAttachResponse
400	Bad Request	None
401	Unauthorized	None
409	Conflict	None

Example HTTP request

Request path

/v1/volumes/{volume_id}/servers

Request header

"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"
}

3.3 - 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

HTTP Code	Description	Schema
202	Accepted	VolumeServerAttachResponse
400	Bad Request	None
401	Unauthorized	None
409	Conflict	None

Example HTTP request

Request path

/v1/volumes/{volume_id}/servers

Request header

"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"
}

3.4 - 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

HTTP Code	Description	Schema
202	Accepted	VolumeServerAttachResponse
400	Bad Request	None
401	Unauthorized	None
409	Conflict	None

Example HTTP request

Request path

/v1/volumes/{volume_id}/servers

Request header

"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"
}

4 - Create a snapshot

4.1 - 1.3

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)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
body	body required		SnapshotCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	SnapshotDetailResponse
400	Bad Request	None
401	Unauthorized	None

Example HTTP request

Request path

/v1/snapshots

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

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"
}

4.2 - 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 (SUPPORTED)

Version	Not Before
1.2	20260831

Parameters

Type	Name	Description	Schema	Default
body	body required		SnapshotCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	SnapshotDetailResponse
400	Bad Request	None
401	Unauthorized	None

Example HTTP request

Request path

/v1/snapshots

Request header

"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"
}

4.3 - 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

Type	Name	Description	Schema	Default
body	body required		SnapshotCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	SnapshotDetailResponse
400	Bad Request	None
401	Unauthorized	None

Example HTTP request

Request path

/v1/snapshots

Request header

"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"
}

4.4 - 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

Type	Name	Description	Schema	Default
body	body required		SnapshotCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	SnapshotDetailResponse
400	Bad Request	None
401	Unauthorized	None

Example HTTP request

Request path

/v1/snapshots

Request header

"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"
}

5 - Create a volume transfer

5.1 - 1.3

post /v1/volume-transfer

Description

Create a volume transfer.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
body	body required		VolumeTransferRequest

Responses

HTTP Code	Description	Schema
202	Accepted	VolumeTransferCreateResponse
400	Bad Request	None
401	Unauthorized	None

Example HTTP request

Request path

/v1/volume-transfer

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

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"
}

5.2 - 1.2

post /v1/volume-transfer

Description

Create a volume transfer.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

Parameters

Type	Name	Description	Schema	Default
body	body required		VolumeTransferRequest

Responses

HTTP Code	Description	Schema
202	Accepted	VolumeTransferCreateResponse
400	Bad Request	None
401	Unauthorized	None

Example HTTP request

Request path

/v1/volume-transfer

Request header

"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"
}

5.3 - 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

Type	Name	Description	Schema	Default
body	body required		VolumeTransferRequest

Responses

HTTP Code	Description	Schema
202	Accepted	VolumeTransferCreateResponse
400	Bad Request	None
401	Unauthorized	None

Example HTTP request

Request path

/v1/volume-transfer

Request header

"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"
}

5.4 - 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

Type	Name	Description	Schema	Default
body	body required		VolumeTransferRequest

Responses

HTTP Code	Description	Schema
202	Accepted	VolumeTransferCreateResponse
400	Bad Request	None
401	Unauthorized	None

Example HTTP request

Request path

/v1/volume-transfer

Request header

"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"
}

6 - Create Auto-Scaling Group

6.1 - 1.3

post /v1/auto-scaling-groups

Description

Create Auto-Scaling Group.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
body	body required		AutoScalingGroupCreateRequestV1Dot2

Responses

HTTP Code	Description	Schema
201	Created	AutoScalingGroupShowResponseV1Dot2
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/auto-scaling-groups

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

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"
}

6.2 - 1.2

post /v1/auto-scaling-groups

Description

Create Auto-Scaling Group.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

Parameters

Type	Name	Description	Schema	Default
body	body required		AutoScalingGroupCreateRequestV1Dot2

Responses

HTTP Code	Description	Schema
201	Created	AutoScalingGroupShowResponseV1Dot2
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/auto-scaling-groups

Request header

"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"
}

6.3 - 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

Type	Name	Description	Schema	Default
body	body required		AutoScalingGroupCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	AutoScalingGroupShowResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/auto-scaling-groups

Request header

"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"
}

6.4 - 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

Type	Name	Description	Schema	Default
body	body required		AutoScalingGroupCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	AutoScalingGroupShowResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/auto-scaling-groups

Request header

"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"
}

7 - Create Auto-Scaling Group Notification

7.1 - 1.3

post /v1/auto-scaling-groups/{auto_scaling_group_id}/notifications

Description

Create Auto-Scaling Group notification.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	auto_scaling_group_id required	Auto-Scaling Group ID Example : `52613bd852b04b39adcb15a8364d856d`	string	None
body	body required		AutoScalingGroupNotificationCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	AutoScalingGroupNotificationListResponse
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}/notifications

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

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"
        }
    ]
}

7.2 - 1.2

post /v1/auto-scaling-groups/{auto_scaling_group_id}/notifications

Description

Create Auto-Scaling Group notification.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

Parameters

Type	Name	Description	Schema	Default
path	auto_scaling_group_id required	Auto-Scaling Group ID Example : `52613bd852b04b39adcb15a8364d856d`	string	None
body	body required		AutoScalingGroupNotificationCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	AutoScalingGroupNotificationListResponse
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}/notifications

Request header

"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"
        }
    ]
}

7.3 - 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

Type	Name	Description	Schema	Default
path	auto_scaling_group_id required	Auto-Scaling Group ID Example : `52613bd852b04b39adcb15a8364d856d`	string	None
body	body required		AutoScalingGroupNotificationCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	AutoScalingGroupNotificationListResponse
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}/notifications

Request header

"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"
        }
    ]
}

7.4 - 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

Type	Name	Description	Schema	Default
path	auto_scaling_group_id required	Auto-Scaling Group ID Example : `52613bd852b04b39adcb15a8364d856d`	string	None
body	body required		AutoScalingGroupNotificationCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	AutoScalingGroupNotificationListResponse
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}/notifications

Request header

"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"
        }
    ]
}

8 - Create Auto-Scaling Group Policy

8.1 - 1.3

post /v1/auto-scaling-groups/{auto_scaling_group_id}/policies

Description

Create Auto-Scaling Group policy.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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

HTTP Code	Description	Schema
201	Created	AutoScalingGroupPolicyShowResponse
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}/policies

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

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": "%"
}

8.2 - 1.2

post /v1/auto-scaling-groups/{auto_scaling_group_id}/policies

Description

Create Auto-Scaling Group policy.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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

HTTP Code	Description	Schema
201	Created	AutoScalingGroupPolicyShowResponse
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}/policies

Request header

"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": "%"
}

8.3 - 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

HTTP Code	Description	Schema
201	Created	AutoScalingGroupPolicyShowResponse
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}/policies

Request header

"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": "%"
}

8.4 - 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

HTTP Code	Description	Schema
201	Created	AutoScalingGroupPolicyShowResponse
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}/policies

Request header

"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": "%"
}

9 - Create Auto-Scaling Group Schedule

9.1 - 1.3

post /v1/auto-scaling-groups/{auto_scaling_group_id}/schedules

Description

Create Auto-Scaling Group schedule.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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

HTTP Code	Description	Schema
201	Created	AutoScalingGroupScheduleShowResponse
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}/schedules

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

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"
}

9.2 - 1.2

post /v1/auto-scaling-groups/{auto_scaling_group_id}/schedules

Description

Create Auto-Scaling Group schedule.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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

HTTP Code	Description	Schema
201	Created	AutoScalingGroupScheduleShowResponse
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}/schedules

Request header

"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"
}

9.3 - 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

HTTP Code	Description	Schema
201	Created	AutoScalingGroupScheduleShowResponse
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}/schedules

Request header

"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"
}

9.4 - 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

HTTP Code	Description	Schema
201	Created	AutoScalingGroupScheduleShowResponse
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}/schedules

Request header

"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"
}

10 - Create Image

10.1 - 1.3

post /v1/images

Description

Create Image.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
body	body required		ImageCreateRequest

Responses

HTTP Code	Description	Schema
200	OK	ImageShowResponseV1Dot2
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/images

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

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}]"
}

10.2 - 1.2

post /v1/images

Description

Create Image.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

Parameters

Type	Name	Description	Schema	Default
body	body required		ImageCreateRequest

Responses

HTTP Code	Description	Schema
200	OK	ImageShowResponseV1Dot2
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/images

Request header

"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}]"
}

10.3 - 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

Type	Name	Description	Schema	Default
body	body required		ImageCreateRequest

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

Request header

"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}]"
}

10.4 - 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

Type	Name	Description	Schema	Default
body	body required		ImageCreateRequest

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

Request header

"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}]"
}

11 - Create Image member

11.1 - 1.3

post /v1/images/{image_id}/members

Description

Add account ID as a shared Image member.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

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"
}

11.2 - 1.2

post /v1/images/{image_id}/members

Description

Add account ID as a shared Image member.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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

Request header

"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"
}

11.3 - 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

Request header

"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"
}

11.4 - 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

Request header

"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"
}

12 - Create Keypair

12.1 - 1.3

post /v1/keypairs

Description

Create a new Keypair or Import a Public Key.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
body	body required		KeypairCreateRequest

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

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

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"
}

12.2 - 1.2

post /v1/keypairs

Description

Create a new Keypair or Import a Public Key.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

Parameters

Type	Name	Description	Schema	Default
body	body required		KeypairCreateRequest

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

Request header

"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"
}

12.3 - 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

Type	Name	Description	Schema	Default
body	body required		KeypairCreateRequest

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

Request header

"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"
}

12.4 - 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

Type	Name	Description	Schema	Default
body	body required		KeypairCreateRequest

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

Request header

"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"
}

13 - Create Launch Configuration

13.1 - 1.3

post /v1/launch-configurations

Description

Create Launch Configuration.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
body	body required		LaunchConfigurationCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	LaunchConfigurationDetailShowResponseV1Dot2
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/launch-configurations

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

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"
        }
    ]
}

13.2 - 1.2

post /v1/launch-configurations

Description

Create Launch Configuration.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

Parameters

Type	Name	Description	Schema	Default
body	body required		LaunchConfigurationCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	LaunchConfigurationDetailShowResponseV1Dot2
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/launch-configurations

Request header

"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"
        }
    ]
}

13.3 - 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

Type	Name	Description	Schema	Default
body	body required		LaunchConfigurationCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	LaunchConfigurationDetailShowResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/launch-configurations

Request header

"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"
        }
    ]
}

13.4 - 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

Type	Name	Description	Schema	Default
body	body required		LaunchConfigurationCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	LaunchConfigurationDetailShowResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/launch-configurations

Request header

"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"
        }
    ]
}

14 - Create Server Group

14.1 - 1.3

post /v1/server-groups

Description

Create server group.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
body	body required		ServerGroupCreateRequest

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

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

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"
}

14.2 - 1.2

post /v1/server-groups

Description

Create server group.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

Parameters

Type	Name	Description	Schema	Default
body	body required		ServerGroupCreateRequest

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

Request header

"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"
}

14.3 - 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

Type	Name	Description	Schema	Default
body	body required		ServerGroupCreateRequest

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

Request header

"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"
}

14.4 - 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

Type	Name	Description	Schema	Default
body	body required		ServerGroupCreateRequest

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

Request header

"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"
}

15 - Create Server Interface

15.1 - 1.3

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)

Version	Not Before
1.3	-

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

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

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"
}

15.2 - 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 (SUPPORTED)

Version	Not Before
1.2	20260831

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

Request header

"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"
}

15.3 - 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

Request header

"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"
}

15.4 - 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

Request header

"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"
}

16 - Create Server Interface Nat

16.1 - 1.3

post /v1/servers/{server_id}/interfaces/{port_id}/static-nats

Description

Create Server Interface Public Nat.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

Request body

{
    "publicip_id": "615fa9cd5cff486c9de679b3ce63e601"
}

Example HTTP response

Response 201

16.2 - 1.2

post /v1/servers/{server_id}/interfaces/{port_id}/static-nats

Description

Create Server Interface Public Nat.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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

Request header

"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

16.3 - 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

Request header

"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

16.4 - 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

Request header

"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

17 - Create Server Interface Private Nat

17.1 - 1.3

post /v1/servers/{server_id}/interfaces/{port_id}/private-static-nats

Description

Create Server Interface Private Nat.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

Request body

{
    "private_nat_id": "3a6c1dc6b1b24e02a444d672c2798a1c",
    "private_nat_ip_id": "1f0cb5390c40483592ddc5a282f53496"
}

Example HTTP response

Response 201

17.2 - 1.2

post /v1/servers/{server_id}/interfaces/{port_id}/private-static-nats

Description

Create Server Interface Private Nat.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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

Request header

"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

17.3 - 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

Request header

"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

17.4 - 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

Request header

"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

18 - Create Server Volume

18.1 - 1.3

post /v1/servers/{server_id}/volumes

Description

Attach volume that are created to server.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

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"
}

18.2 - 1.2

post /v1/servers/{server_id}/volumes

Description

Attach volume that are created to server.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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

Request header

"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"
}

18.3 - 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

Request header

"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"
}

18.4 - 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

Request header

"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"
}

19 - Create Sharing Image

19.1 - 1.3

post /v1/images/{image_id}/share

Description

Create Sharing Image.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

Example HTTP response

Response 202

19.2 - 1.2

post /v1/images/{image_id}/share

Description

Create Sharing Image.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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

Request header

"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

19.3 - 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

Request header

"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

19.4 - 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

Request header

"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

20 - Create Virtual Server

20.1 - 1.3

post /v1/servers

Description

Create Virtual Server.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
body	body required		ServerCreateRequestV1Dot2

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

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

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"
        }
    ]
}

20.2 - 1.2

post /v1/servers

Description

Create Virtual Server.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

Parameters

Type	Name	Description	Schema	Default
body	body required		ServerCreateRequestV1Dot2

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

Request header

"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"
        }
    ]
}

20.3 - 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

Type	Name	Description	Schema	Default
body	body required		ServerCreateRequest

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

Request header

"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"
        }
    ]
}

20.4 - 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

Type	Name	Description	Schema	Default
body	body required		ServerCreateRequest

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

Request header

"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"
        }
    ]
}

21 - Create Virtual Server Custom Image

21.1 - 1.3

post /v1/servers/{server_id}/images

Description

Create Virtual Server Custom Image.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

Request body

{
    "image_name": "imagename"
}

Example HTTP response

Response 202

{
    "image_id": "70a599e0-31e7-49b7-b260-868f441e862b"
}

21.2 - 1.2

post /v1/servers/{server_id}/images

Description

Create Virtual Server Custom Image.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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

Request header

"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"
}

21.3 - 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

Request header

"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"
}

21.4 - 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

Request header

"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"
}

22 - Create Virtual Server Dump

22.1 - 1.3

post /v1/servers/{server_id}/dump

Description

Create Virtual Server Dump.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

Example HTTP response

Response 202

22.2 - 1.2

post /v1/servers/{server_id}/dump

Description

Create Virtual Server Dump.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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

Request header

"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

22.3 - 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

Request header

"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

22.4 - 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

Request header

"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

23 - Create Volume

23.1 - 1.3

post /v1/volumes

Description

Create a Volume.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
body	body required		VolumeCreateRequestV1Dot2

Responses

HTTP Code	Description	Schema
202	Accepted	VolumeShowResponseV1Dot2
400	Bad Request	None
401	Unauthorized	None

Example HTTP request

Request path

/v1/volumes

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

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": "2024-01-15T10:30:00.000Z",
    "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": "2024-01-15T10:30:00.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"
}

23.2 - 1.2

post /v1/volumes

Description

Create a Volume.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

Parameters

Type	Name	Description	Schema	Default
body	body required		VolumeCreateRequestV1Dot2

Responses

HTTP Code	Description	Schema
202	Accepted	VolumeShowResponseV1Dot2
400	Bad Request	None
401	Unauthorized	None

Example HTTP request

Request path

/v1/volumes

Request header

"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": "2024-01-15T10:30:00.000Z",
    "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": "2024-01-15T10:30:00.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"
}

23.3 - 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

Type	Name	Description	Schema	Default
body	body required		VolumeCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	VolumeShowResponse
400	Bad Request	None
401	Unauthorized	None

Example HTTP request

Request path

/v1/volumes

Request header

"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": "2024-01-15T10:30:00.000Z",
    "encrypted": true,
    "id": "3f500f00-ed80-4566-a057-e31760226f9a",
    "modified_at": "2025-07-26T12:00:00Z",
    "multiattach": false,
    "name": "volume01",
    "servers": [
        {
            "attached_at": "2024-01-15T10:30:00.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"
}

23.4 - 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

Type	Name	Description	Schema	Default
body	body required		VolumeCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	VolumeShowResponse
400	Bad Request	None
401	Unauthorized	None

Example HTTP request

Request path

/v1/volumes

Request header

"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": "2024-01-15T10:30:00.000Z",
    "encrypted": true,
    "id": "3f500f00-ed80-4566-a057-e31760226f9a",
    "modified_at": "2025-07-26T12:00:00Z",
    "multiattach": false,
    "name": "volume01",
    "servers": [
        {
            "attached_at": "2024-01-15T10:30:00.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"
}

24 - Delete a snapshot

24.1 - 1.3

delete /v1/snapshots/{snapshot_id}

Description

Delete a snapshot.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

Example HTTP response

Response 202

24.2 - 1.2

delete /v1/snapshots/{snapshot_id}

Description

Delete a snapshot.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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}

Request header

"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

24.3 - 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}

Request header

"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

24.4 - 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}

Request header

"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

25 - Delete a volume transfer

25.1 - 1.3

delete /v1/volume-transfer/{transfer_id}

Description

Delete a volume transfer.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

Example HTTP response

Response 202

25.2 - 1.2

delete /v1/volume-transfer/{transfer_id}

Description

Delete a volume transfer.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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}

Request header

"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

25.3 - 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}

Request header

"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

25.4 - 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}

Request header

"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

26 - Delete Auto-Scaling Group

26.1 - 1.3

delete /v1/auto-scaling-groups/{auto_scaling_group_id}

Description

Delete Auto-Scaling Group.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

Example HTTP response

Response 204

26.2 - 1.2

delete /v1/auto-scaling-groups/{auto_scaling_group_id}

Description

Delete Auto-Scaling Group.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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}

Request header

"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

26.3 - 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}

Request header

"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

26.4 - 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}

Request header

"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

27 - Delete Auto-Scaling Group Notification

27.1 - 1.3

delete /v1/auto-scaling-groups/{auto_scaling_group_id}/notifications/{notification_id}

Description

Delete Auto-Scaling Group notification.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

Example HTTP response

Response 204

27.2 - 1.2

delete /v1/auto-scaling-groups/{auto_scaling_group_id}/notifications/{notification_id}

Description

Delete Auto-Scaling Group notification.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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}

Request header

"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

27.3 - 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}

Request header

"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

27.4 - 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}

Request header

"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

28 - Delete Auto-Scaling Group Policy

28.1 - 1.3

delete /v1/auto-scaling-groups/{auto_scaling_group_id}/policies/{policy_id}

Description

Delete Auto-Scaling Group policy.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

Example HTTP response

Response 204

28.2 - 1.2

delete /v1/auto-scaling-groups/{auto_scaling_group_id}/policies/{policy_id}

Description

Delete Auto-Scaling Group policy.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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}

Request header

"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

28.3 - 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}

Request header

"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

28.4 - 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}

Request header

"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

29 - Delete Auto-Scaling Group Schedule

29.1 - 1.3

delete /v1/auto-scaling-groups/{auto_scaling_group_id}/schedules/{schedule_id}

Description

Delete Auto-Scaling Group schedule.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

Example HTTP response

Response 204

29.2 - 1.2

delete /v1/auto-scaling-groups/{auto_scaling_group_id}/schedules/{schedule_id}

Description

Delete Auto-Scaling Group schedule.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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}

Request header

"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

29.3 - 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}

Request header

"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

29.4 - 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}

Request header

"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

30 - Delete Image

30.1 - 1.3

delete /v1/images/{image_id}

Description

Delete Image.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

Example HTTP response

Response 204

30.2 - 1.2

delete /v1/images/{image_id}

Description

Delete Image.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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}

Request header

"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

30.3 - 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}

Request header

"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

30.4 - 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}

Request header

"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

31 - Delete Image member

31.1 - 1.3

delete /v1/images/{image_id}/members/{member_id}

Description

Delete Image member.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

Example HTTP response

Response 204

31.2 - 1.2

delete /v1/images/{image_id}/members/{member_id}

Description

Delete Image member.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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}

Request header

"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

31.3 - 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}

Request header

"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

31.4 - 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}

Request header

"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

32 - Delete Keypair

32.1 - 1.3

delete /v1/keypairs/{keypair_name}

Description

Delete keypair.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

Example HTTP response

Response 204

32.2 - 1.2

delete /v1/keypairs/{keypair_name}

Description

Delete keypair.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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}

Request header

"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

32.3 - 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}

Request header

"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

32.4 - 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}

Request header

"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

33 - Delete Launch Configuration

33.1 - 1.3

delete /v1/launch-configurations/{launch_configuration_id}

Description

Delete Launch Configuration.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

Example HTTP response

Response 204

33.2 - 1.2

delete /v1/launch-configurations/{launch_configuration_id}

Description

Delete Launch Configuration.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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}

Request header

"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

33.3 - 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}

Request header

"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

33.4 - 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}

Request header

"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

34 - Delete Server Group

34.1 - 1.3

delete /v1/server-groups/{server_group_id}

Description

Delete server group

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

Example HTTP response

Response 200

34.2 - 1.2

delete /v1/server-groups/{server_group_id}

Description

Delete server group

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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}

Request header

"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

34.3 - 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}

Request header

"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

34.4 - 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}

Request header

"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

35 - Delete Server Interface

35.1 - 1.3

delete /v1/servers/{server_id}/interfaces/{port_id}

Description

Delete Server Interface.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

Example HTTP response

Response 200

35.2 - 1.2

delete /v1/servers/{server_id}/interfaces/{port_id}

Description

Delete Server Interface.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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}

Request header

"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

35.3 - 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}

Request header

"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

35.4 - 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}

Request header

"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

36 - Delete Server Interface Nat

36.1 - 1.3

delete /v1/servers/{server_id}/interfaces/{port_id}/static-nats/{nat_id}

Description

Delete Server Interface Public Nat.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

Example HTTP response

Response 202

36.2 - 1.2

delete /v1/servers/{server_id}/interfaces/{port_id}/static-nats/{nat_id}

Description

Delete Server Interface Public Nat.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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}

Request header

"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

36.3 - 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}

Request header

"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

36.4 - 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}

Request header

"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

37 - Delete Server Interface Private Nat

37.1 - 1.3

delete /v1/servers/{server_id}/interfaces/{port_id}/private-static-nats/{nat_id}

Description

Delete Server Interface Private Nat.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

Example HTTP response

Response 202

37.2 - 1.2

delete /v1/servers/{server_id}/interfaces/{port_id}/private-static-nats/{nat_id}

Description

Delete Server Interface Private Nat.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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}

Request header

"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

37.3 - 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}

Request header

"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

37.4 - 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}

Request header

"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

38 - Delete Server Volume

38.1 - 1.3

delete /v1/servers/{server_id}/volumes/{volume_id}

Description

Delete Server Volume.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

Example HTTP response

Response 202

38.2 - 1.2

delete /v1/servers/{server_id}/volumes/{volume_id}

Description

Delete Server Volume.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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}

Request header

"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

38.3 - 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}

Request header

"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

38.4 - 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}

Request header

"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

39 - Delete Virtual Server

39.1 - 1.3

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.

File Storage connected
LB Server Group connected(Except VMs generated by Auto-Scaling Group)
Lock set
Backup connected

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

Example HTTP response

Response 202

39.2 - 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.

File Storage connected
LB Server Group connected(Except VMs generated by Auto-Scaling Group)
Lock set
Backup connected

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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}

Request header

"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

39.3 - 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.

File Storage connected
LB Server Group connected(Except VMs generated by Auto-Scaling Group)
Lock set
Backup connected

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}

Request header

"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

39.4 - 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.

File Storage connected
LB Server Group connected(Except VMs generated by Auto-Scaling Group)
Lock set
Backup connected

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}

Request header

"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

40 - Delete Volume

40.1 - 1.3

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)

Version	Not Before
1.3	-

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}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

Example HTTP response

Response 202

40.2 - 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 (SUPPORTED)

Version	Not Before
1.2	20260831

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}

Request header

"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

40.3 - 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}

Request header

"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

40.4 - 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}

Request header

"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

41 - Detach Virtual Server Security Group

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}

Request header

"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

42 - Detach Volume from Virtual Server

42.1 - 1.3

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)

Version	Not Before
1.3	-

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}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

Example HTTP response

Response 202

42.2 - 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 (SUPPORTED)

Version	Not Before
1.2	20260831

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}

Request header

"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

42.3 - 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}

Request header

"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

42.4 - 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}

Request header

"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

43 - Extend Volume

43.1 - 1.3

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)

Version	Not Before
1.3	-

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	VolumeShowResponseV1Dot2
400	Bad Request	None
401	Unauthorized	None
409	Conflict	None

Example HTTP request

Request path

/v1/volumes/{volume_id}/size

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

Request body

{
    "size": 104
}

Example HTTP response

Response 202

{
    "bootable": false,
    "created_at": "2024-01-15T10:30:00.000Z",
    "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": "2024-01-15T10:30:00.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"
}

43.2 - 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 (SUPPORTED)

Version	Not Before
1.2	20260831

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	VolumeShowResponseV1Dot2
400	Bad Request	None
401	Unauthorized	None
409	Conflict	None

Example HTTP request

Request path

/v1/volumes/{volume_id}/size

Request header

"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

{
    "size": 104
}

Example HTTP response

Response 202

{
    "bootable": false,
    "created_at": "2024-01-15T10:30:00.000Z",
    "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": "2024-01-15T10:30:00.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"
}

43.3 - 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

Request header

"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

{
    "size": 104
}

Example HTTP response

Response 202

{
    "bootable": false,
    "created_at": "2024-01-15T10:30:00.000Z",
    "encrypted": true,
    "id": "3f500f00-ed80-4566-a057-e31760226f9a",
    "modified_at": "2025-07-26T12:00:00Z",
    "multiattach": false,
    "name": "volume01",
    "servers": [
        {
            "attached_at": "2024-01-15T10:30:00.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"
}

43.4 - 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

Request header

"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

{
    "size": 104
}

Example HTTP response

Response 202

{
    "bootable": false,
    "created_at": "2024-01-15T10:30:00.000Z",
    "encrypted": true,
    "id": "3f500f00-ed80-4566-a057-e31760226f9a",
    "modified_at": "2025-07-26T12:00:00Z",
    "multiattach": false,
    "name": "volume01",
    "servers": [
        {
            "attached_at": "2024-01-15T10:30:00.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"
}

44 - Get region's maximum partition size.

44.1 - 1.3

get /v1/server-groups/partition-size

Description

Get region’s maximum partition size

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Responses

HTTP Code	Description	Schema
200	OK	ServerGroupPartitionSizeResponse
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/server-groups/partition-size

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

Example HTTP response

Response 200

{
    "partition_size": ""
}

44.2 - 1.2

get /v1/server-groups/partition-size

Description

Get region’s maximum partition size

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

Responses

HTTP Code	Description	Schema
200	OK	ServerGroupPartitionSizeResponse
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/server-groups/partition-size

Request header

"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

{
    "partition_size": ""
}

44.3 - 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

HTTP Code	Description	Schema
200	OK	ServerGroupPartitionSizeResponse
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/server-groups/partition-size

Request header

"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

{
    "partition_size": ""
}

44.4 - 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

HTTP Code	Description	Schema
200	OK	ServerGroupPartitionSizeResponse
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/server-groups/partition-size

Request header

"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

{
    "partition_size": ""
}

45 - Import Image

45.1 - 1.3

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)

Version	Not Before
1.3	-

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

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

Request body

{
    "url": "https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2"
}

Example HTTP response

Response 202

45.2 - 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 (SUPPORTED)

Version	Not Before
1.2	20260831

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

Request header

"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

45.3 - 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

Request header

"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

45.4 - 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

Request header

"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

46 - List Auto-Scaling Group LB Server Groups

46.1 - 1.3

get /v1/auto-scaling-groups/{auto_scaling_group_id}/lb-server-groups

Description

List Auto-Scaling Group LB Server Groups.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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

HTTP Code	Description	Schema
200	OK	AutoScalingGroupLbServerGroupListResponse
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

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

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
        }
    ]
}

46.2 - 1.2

get /v1/auto-scaling-groups/{auto_scaling_group_id}/lb-server-groups

Description

List Auto-Scaling Group LB Server Groups.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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

HTTP Code	Description	Schema
200	OK	AutoScalingGroupLbServerGroupListResponse
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

Request header

"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
        }
    ]
}

46.3 - 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

HTTP Code	Description	Schema
200	OK	AutoScalingGroupLbServerGroupListResponse
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

Request header

"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
        }
    ]
}

46.4 - 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

HTTP Code	Description	Schema
200	OK	AutoScalingGroupLbServerGroupListResponse
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

Request header

"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
        }
    ]
}

47 - List Auto-Scaling Group Notifications

47.1 - 1.3

get /v1/auto-scaling-groups/{auto_scaling_group_id}/notifications

Description

List Auto-Scaling Group notifications.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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

HTTP Code	Description	Schema
200	OK	AutoScalingGroupNotificationListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/auto-scaling-groups/{auto_scaling_group_id}/notifications

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

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"
        }
    ]
}

47.2 - 1.2

get /v1/auto-scaling-groups/{auto_scaling_group_id}/notifications

Description

List Auto-Scaling Group notifications.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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

HTTP Code	Description	Schema
200	OK	AutoScalingGroupNotificationListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/auto-scaling-groups/{auto_scaling_group_id}/notifications

Request header

"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"
        }
    ]
}

47.3 - 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

HTTP Code	Description	Schema
200	OK	AutoScalingGroupNotificationListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/auto-scaling-groups/{auto_scaling_group_id}/notifications

Request header

"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"
        }
    ]
}

47.4 - 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

HTTP Code	Description	Schema
200	OK	AutoScalingGroupNotificationListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/auto-scaling-groups/{auto_scaling_group_id}/notifications

Request header

"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"
        }
    ]
}

48 - List Auto-Scaling Group Policies

48.1 - 1.3

get /v1/auto-scaling-groups/{auto_scaling_group_id}/policies

Description

List Auto-Scaling Group policies.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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

HTTP Code	Description	Schema
200	OK	AutoScalingGroupPolicyListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/auto-scaling-groups/{auto_scaling_group_id}/policies

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

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": "%"
        }
    ]
}

48.2 - 1.2

get /v1/auto-scaling-groups/{auto_scaling_group_id}/policies

Description

List Auto-Scaling Group policies.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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

HTTP Code	Description	Schema
200	OK	AutoScalingGroupPolicyListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/auto-scaling-groups/{auto_scaling_group_id}/policies

Request header

"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": "%"
        }
    ]
}

48.3 - 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

HTTP Code	Description	Schema
200	OK	AutoScalingGroupPolicyListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/auto-scaling-groups/{auto_scaling_group_id}/policies

Request header

"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": "%"
        }
    ]
}

48.4 - 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

HTTP Code	Description	Schema
200	OK	AutoScalingGroupPolicyListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/auto-scaling-groups/{auto_scaling_group_id}/policies

Request header

"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": "%"
        }
    ]
}

49 - List Auto-Scaling Group Schedules

49.1 - 1.3

get /v1/auto-scaling-groups/{auto_scaling_group_id}/schedules

Description

Get Auto-Scaling Group schedule list.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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

HTTP Code	Description	Schema
200	OK	AutoScalingGroupScheduleListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/auto-scaling-groups/{auto_scaling_group_id}/schedules

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

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"
    ]
}

49.2 - 1.2

get /v1/auto-scaling-groups/{auto_scaling_group_id}/schedules

Description

Get Auto-Scaling Group schedule list.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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

HTTP Code	Description	Schema
200	OK	AutoScalingGroupScheduleListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/auto-scaling-groups/{auto_scaling_group_id}/schedules

Request header

"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"
    ]
}

49.3 - 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

HTTP Code	Description	Schema
200	OK	AutoScalingGroupScheduleListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/auto-scaling-groups/{auto_scaling_group_id}/schedules

Request header

"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"
    ]
}

49.4 - 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

HTTP Code	Description	Schema
200	OK	AutoScalingGroupScheduleListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/auto-scaling-groups/{auto_scaling_group_id}/schedules

Request header

"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"
    ]
}

50 - List Auto-Scaling Group Virtual Servers

50.1 - 1.3

get /v1/auto-scaling-groups/{auto_scaling_group_id}/virtual-servers

Description

List Auto-Scaling Group Virtual Servers.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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

HTTP Code	Description	Schema
200	OK	AutoScalingGroupVirtualServerListResponseV1Dot2
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}/virtual-servers

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

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": "2024-01-15T10:30:00.000Z",
            "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": "2024-01-15T10:30:00.000Z",
            "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"
        }
    ]
}

50.2 - 1.2

get /v1/auto-scaling-groups/{auto_scaling_group_id}/virtual-servers

Description

List Auto-Scaling Group Virtual Servers.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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

HTTP Code	Description	Schema
200	OK	AutoScalingGroupVirtualServerListResponseV1Dot2
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}/virtual-servers

Request header

"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": "2024-01-15T10:30:00.000Z",
            "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": "2024-01-15T10:30:00.000Z",
            "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"
        }
    ]
}

50.3 - 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

HTTP Code	Description	Schema
200	OK	AutoScalingGroupVirtualServerListResponse
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}/virtual-servers

Request header

"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": "2024-01-15T10:30:00.000Z",
            "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": "2024-01-15T10:30:00.000Z",
            "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"
        }
    ]
}

50.4 - 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

HTTP Code	Description	Schema
200	OK	AutoScalingGroupVirtualServerListResponse
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}/virtual-servers

Request header

"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": "2024-01-15T10:30:00.000Z",
            "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": "2024-01-15T10:30:00.000Z",
            "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"
        }
    ]
}

51 - List Auto-Scaling Groups

51.1 - 1.3

get /v1/auto-scaling-groups

Description

List Auto-Scaling Groups.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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

HTTP Code	Description	Schema
200	OK	AutoScalingGroupListResponseV1Dot2
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/auto-scaling-groups

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

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
}

51.2 - 1.2

get /v1/auto-scaling-groups

Description

List Auto-Scaling Groups.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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

HTTP Code	Description	Schema
200	OK	AutoScalingGroupListResponseV1Dot2
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/auto-scaling-groups

Request header

"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
}

51.3 - 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

HTTP Code	Description	Schema
200	OK	AutoScalingGroupListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/auto-scaling-groups

Request header

"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
}

51.4 - 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

HTTP Code	Description	Schema
200	OK	AutoScalingGroupListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/auto-scaling-groups

Request header

"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
}

52 - List Default Configs

52.1 - 1.3

get /v1/default-configs

Description

Retrieves a list of default configuration values, including resource‑usage limits, thresholds, and related settings.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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

HTTP Code	Description	Schema
200	OK	DefaultConfigListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/default-configs

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

Example HTTP response

Response 200

{
    "configs": "('key': 'value'}",
    "count": 20
}

52.2 - 1.2

get /v1/default-configs

Description

Retrieves a list of default configuration values, including resource‑usage limits, thresholds, and related settings.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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

HTTP Code	Description	Schema
200	OK	DefaultConfigListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/default-configs

Request header

"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
}

52.3 - 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

HTTP Code	Description	Schema
200	OK	DefaultConfigListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/default-configs

Request header

"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
}

52.4 - 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

HTTP Code	Description	Schema
200	OK	DefaultConfigListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/default-configs

Request header

"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
}

53 - List Image members

53.1 - 1.3

get /v1/images/{image_id}/members

Description

Retrieves the list of account members with whom the image owner has shared the image.

You can request image sharing between accounts.
Image members have read‑only permission on the image.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

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"
        }
    ]
}

53.2 - 1.2

get /v1/images/{image_id}/members

Description

Retrieves the list of account members with whom the image owner has shared the image.

You can request image sharing between accounts.
Image members have read‑only permission on the image.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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

Request header

"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"
        }
    ]
}

53.3 - 1.1

get /v1/images/{image_id}/members

Description

Retrieves the list of account members with whom the image owner has shared the image.

You can request image sharing between accounts.
Image members have read‑only permission on 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

Request header

"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"
        }
    ]
}

53.4 - 1.0

get /v1/images/{image_id}/members

Description

Retrieves the list of account members with whom the image owner has shared the image.

You can request image sharing between accounts.
Image members have read‑only permission on 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

Request header

"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"
        }
    ]
}

54 - List Images

54.1 - 1.3

get /v1/images

Description

List Images.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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	ImageListResponseV1Dot3
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/images

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

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",
            "scp_supported_class_types": "GPU-A100-1,GPU-H100-2",
            "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}]"
        }
    ]
}

54.2 - 1.2

get /v1/images

Description

List Images.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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	ImageListResponseV1Dot2
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/images

Request header

"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}]"
        }
    ]
}

54.3 - 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

Request header

"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}]"
        }
    ]
}

54.4 - 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

Request header

"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}]"
        }
    ]
}

55 - List Keypairs

55.1 - 1.3

get /v1/keypairs

Description

Get keypair list.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

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"
        }
    ]
}

55.2 - 1.2

get /v1/keypairs

Description

Get keypair list.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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

Request header

"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"
        }
    ]
}

55.3 - 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

Request header

"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"
        }
    ]
}

55.4 - 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

Request header

"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"
        }
    ]
}

56 - List Launch Configurations

56.1 - 1.3

get /v1/launch-configurations

Description

List Launch Configurations.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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

HTTP Code	Description	Schema
200	OK	LaunchConfigurationListResponseV1Dot2
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/launch-configurations

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

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"
                }
            ]
        }
    ]
}

56.2 - 1.2

get /v1/launch-configurations

Description

List Launch Configurations.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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

HTTP Code	Description	Schema
200	OK	LaunchConfigurationListResponseV1Dot2
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/launch-configurations

Request header

"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"
                }
            ]
        }
    ]
}

56.3 - 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

HTTP Code	Description	Schema
200	OK	LaunchConfigurationListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/launch-configurations

Request header

"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"
                }
            ]
        }
    ]
}

56.4 - 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

HTTP Code	Description	Schema
200	OK	LaunchConfigurationListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/launch-configurations

Request header

"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"
                }
            ]
        }
    ]
}

57 - List pending Images

57.1 - 1.3

get /v1/pending-images

Description

Retrieve a list of images pending sharing.

Image sharing can be requested between accounts.
Member accounts that have been shared an image can view the pending‑share list and decide whether to accept or reject it.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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	ImageListResponseV1Dot2
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/pending-images

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

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}]"
        }
    ]
}

57.2 - 1.2

get /v1/pending-images

Description

Retrieve a list of images pending sharing.

Image sharing can be requested between accounts.
Member accounts that have been shared an image can view the pending‑share list and decide whether to accept or reject it.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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	ImageListResponseV1Dot2
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/pending-images

Request header

"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}]"
        }
    ]
}

57.3 - 1.1

get /v1/pending-images

Description

Retrieve a list of images pending sharing.

Image sharing can be requested between accounts.
Member accounts that have been shared an image can view the pending‑share list and decide whether to accept or reject it.

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

Request header

"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}]"
        }
    ]
}

57.4 - 1.0

get /v1/pending-images

Description

Retrieve a list of images pending sharing.

Image sharing can be requested between accounts.
Member accounts that have been shared an image can view the pending‑share list and decide whether to accept or reject it.

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

Request header

"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}]"
        }
    ]
}

58 - List Server Groups

58.1 - 1.3

get /v1/server-groups

Description

Get server group list.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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

HTTP Code	Description	Schema
200	OK	ServerGroupListResponse
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/server-groups

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

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"
        }
    ]
}

58.2 - 1.2

get /v1/server-groups

Description

Get server group list.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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

HTTP Code	Description	Schema
200	OK	ServerGroupListResponse
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/server-groups

Request header

"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"
        }
    ]
}

58.3 - 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

HTTP Code	Description	Schema
200	OK	ServerGroupListResponse
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/server-groups

Request header

"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"
        }
    ]
}

58.4 - 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

HTTP Code	Description	Schema
200	OK	ServerGroupListResponse
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/server-groups

Request header

"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"
        }
    ]
}

59 - List Server Interfaces

59.1 - 1.3

get /v1/servers/{server_id}/interfaces

Description

List Server Interfaces.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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	ServerInterfaceListResponseV1Dot2
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/servers/{server_id}/interfaces

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

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"
        }
    ]
}

59.2 - 1.2

get /v1/servers/{server_id}/interfaces

Description

List Server Interfaces.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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	ServerInterfaceListResponseV1Dot2
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/servers/{server_id}/interfaces

Request header

"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"
        }
    ]
}

59.3 - 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

HTTP Code	Description	Schema
200	OK	ServerInterfaceListResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/servers/{server_id}/interfaces

Request header

"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"
        }
    ]
}

59.4 - 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

HTTP Code	Description	Schema
200	OK	ServerInterfaceListResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/servers/{server_id}/interfaces

Request header

"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"
        }
    ]
}

60 - List Server Ips

60.1 - 1.3

get /v1/servers/{server_id}/ips

Description

List Server Ips.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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	ServerIpsResponse
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/servers/{server_id}/ips

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

Example HTTP response

Response 200

{
    "addresses": [
        {
            "ip_addresses": [
                {
                    "ip_address": "192.169.3.2",
                    "version": 4
                }
            ],
            "subnet_name": "subnetname"
        }
    ]
}

60.2 - 1.2

get /v1/servers/{server_id}/ips

Description

List Server Ips.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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	ServerIpsResponse
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/servers/{server_id}/ips

Request header

"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"
        }
    ]
}

60.3 - 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

HTTP Code	Description	Schema
200	OK	ServerIpsResponse
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/servers/{server_id}/ips

Request header

"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"
        }
    ]
}

60.4 - 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

HTTP Code	Description	Schema
200	OK	ServerIpsResponse
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/servers/{server_id}/ips

Request header

"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"
        }
    ]
}

61 - List Server Types

61.1 - 1.3

get /v1/server-types

Description

Get server type list.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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

HTTP Code	Description	Schema
200	OK	ServerTypeListResponse
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/server-types

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

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
        }
    ]
}

61.2 - 1.2

get /v1/server-types

Description

Get server type list.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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

HTTP Code	Description	Schema
200	OK	ServerTypeListResponse
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/server-types

Request header

"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
        }
    ]
}

61.3 - 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

HTTP Code	Description	Schema
200	OK	ServerTypeListResponse
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/server-types

Request header

"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
        }
    ]
}

61.4 - 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

HTTP Code	Description	Schema
200	OK	ServerTypeListResponse
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/server-types

Request header

"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
        }
    ]
}

62 - List Server Volumes

62.1 - 1.3

get /v1/servers/{server_id}/volumes

Description

List Server Volumes.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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	ServerVolumesResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/servers/{server_id}/volumes

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

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"
        }
    ]
}

62.2 - 1.2

get /v1/servers/{server_id}/volumes

Description

List Server Volumes.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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	ServerVolumesResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/servers/{server_id}/volumes

Request header

"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"
        }
    ]
}

62.3 - 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

HTTP Code	Description	Schema
200	OK	ServerVolumesResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/servers/{server_id}/volumes

Request header

"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"
        }
    ]
}

62.4 - 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

HTTP Code	Description	Schema
200	OK	ServerVolumesResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/servers/{server_id}/volumes

Request header

"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"
        }
    ]
}

63 - List snapshots

63.1 - 1.3

get /v1/snapshots

Description

List snapshots.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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

HTTP Code	Description	Schema
200	OK	SnapshotListResponse
400	Bad Request	None
401	Unauthorized	None

Example HTTP request

Request path

/v1/snapshots

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

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"
        }
    ]
}

63.2 - 1.2

get /v1/snapshots

Description

List snapshots.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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

HTTP Code	Description	Schema
200	OK	SnapshotListResponse
400	Bad Request	None
401	Unauthorized	None

Example HTTP request

Request path

/v1/snapshots

Request header

"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"
        }
    ]
}

63.3 - 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

HTTP Code	Description	Schema
200	OK	SnapshotListResponse
400	Bad Request	None
401	Unauthorized	None

Example HTTP request

Request path

/v1/snapshots

Request header

"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"
        }
    ]
}

63.4 - 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

HTTP Code	Description	Schema
200	OK	SnapshotListResponse
400	Bad Request	None
401	Unauthorized	None

Example HTTP request

Request path

/v1/snapshots

Request header

"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"
        }
    ]
}

64 - List Virtual Server Security Group

64.1 - 1.3

get /v1/servers/{server_id}/security-groups

Description

List Virtual Server Security Group.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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	ServerSecurityGroupListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/servers/{server_id}/security-groups

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

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
                }
            ]
        }
    ]
}

64.2 - 1.2

get /v1/servers/{server_id}/security-groups

Description

List Virtual Server Security Group.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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	ServerSecurityGroupListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/servers/{server_id}/security-groups

Request header

"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
                }
            ]
        }
    ]
}

64.3 - 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

HTTP Code	Description	Schema
200	OK	ServerSecurityGroupListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/servers/{server_id}/security-groups

Request header

"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
                }
            ]
        }
    ]
}

64.4 - 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

HTTP Code	Description	Schema
200	OK	ServerSecurityGroupListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/servers/{server_id}/security-groups

Request header

"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
                }
            ]
        }
    ]
}

65 - List Virtual Servers

65.1 - 1.3

get /v1/servers

Description

List Virtual Servers.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

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": "2024-01-15T10:30:00.000Z",
            "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": "2024-01-15T10:30:00.000Z",
            "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"
        }
    ]
}

65.2 - 1.2

get /v1/servers

Description

List Virtual Servers.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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

Request header

"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": "2024-01-15T10:30:00.000Z",
            "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": "2024-01-15T10:30:00.000Z",
            "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"
        }
    ]
}

65.3 - 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

Request header

"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": "2024-01-15T10:30:00.000Z",
            "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": "2024-01-15T10:30:00.000Z",
            "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"
        }
    ]
}

65.4 - 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

Request header

"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": "2024-01-15T10:30:00.000Z",
            "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": "2024-01-15T10:30:00.000Z",
            "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"
        }
    ]
}

66 - List volume transfers

66.1 - 1.3

get /v1/volume-transfer

Description

List volume transfers.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Responses

HTTP Code	Description	Schema
200	OK	VolumeTransferListResponse
400	Bad Request	None
401	Unauthorized	None

Example HTTP request

Request path

/v1/volume-transfer

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

Example HTTP response

Response 200

{
    "transfers": [
        {
            "id": "1ac231be-823b-4a4d-8ff0-aac503a7118a",
            "name": "volume01",
            "volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
        }
    ]
}

66.2 - 1.2

get /v1/volume-transfer

Description

List volume transfers.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

Responses

HTTP Code	Description	Schema
200	OK	VolumeTransferListResponse
400	Bad Request	None
401	Unauthorized	None

Example HTTP request

Request path

/v1/volume-transfer

Request header

"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"
        }
    ]
}

66.3 - 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

HTTP Code	Description	Schema
200	OK	VolumeTransferListResponse
400	Bad Request	None
401	Unauthorized	None

Example HTTP request

Request path

/v1/volume-transfer

Request header

"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"
        }
    ]
}

66.4 - 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

HTTP Code	Description	Schema
200	OK	VolumeTransferListResponse
400	Bad Request	None
401	Unauthorized	None

Example HTTP request

Request path

/v1/volume-transfer

Request header

"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"
        }
    ]
}

67 - List volume types

67.1 - 1.3

get /v1/volume-types

Description

List volume types.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

Example HTTP response

Response 200

{
    "volume_types": [
        {
            "description": "Volume type description",
            "extra_specs": {
                "multiattach": "<is> True"
            },
            "id": "c643ac35-3aec-43e6-b97a-3d6f666c5207",
            "name": "SSD"
        }
    ]
}

67.2 - 1.2

get /v1/volume-types

Description

List volume types.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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

Request header

"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"
        }
    ]
}

67.3 - 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

Request header

"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"
        }
    ]
}

67.4 - 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

Request header

"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"
        }
    ]
}

68 - List volumes

68.1 - 1.3

get /v1/volumes

Description

List volumes.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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

HTTP Code	Description	Schema
200	OK	VolumeListResponseV1Dot2
400	Bad Request	None
401	Unauthorized	None

Example HTTP request

Request path

/v1/volumes

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

Example HTTP response

Response 200

{
    "count": 100,
    "volumes": [
        {
            "bootable": false,
            "created_at": "2024-01-15T10:30:00.000Z",
            "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": "2024-01-15T10:30:00.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"
        }
    ]
}

68.2 - 1.2

get /v1/volumes

Description

List volumes.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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

HTTP Code	Description	Schema
200	OK	VolumeListResponseV1Dot2
400	Bad Request	None
401	Unauthorized	None

Example HTTP request

Request path

/v1/volumes

Request header

"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": "2024-01-15T10:30:00.000Z",
            "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": "2024-01-15T10:30:00.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"
        }
    ]
}

68.3 - 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

HTTP Code	Description	Schema
200	OK	VolumeListResponse
400	Bad Request	None
401	Unauthorized	None

Example HTTP request

Request path

/v1/volumes

Request header

"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": "2024-01-15T10:30:00.000Z",
            "encrypted": true,
            "id": "3f500f00-ed80-4566-a057-e31760226f9a",
            "modified_at": "2025-07-26T12:00:00Z",
            "multiattach": false,
            "name": "volume01",
            "servers": [
                {
                    "attached_at": "2024-01-15T10:30:00.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"
        }
    ]
}

68.4 - 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

HTTP Code	Description	Schema
200	OK	VolumeListResponse
400	Bad Request	None
401	Unauthorized	None

Example HTTP request

Request path

/v1/volumes

Request header

"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": "2024-01-15T10:30:00.000Z",
            "encrypted": true,
            "id": "3f500f00-ed80-4566-a057-e31760226f9a",
            "modified_at": "2025-07-26T12:00:00Z",
            "multiattach": false,
            "name": "volume01",
            "servers": [
                {
                    "attached_at": "2024-01-15T10:30:00.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"
        }
    ]
}

69 - Lock Virtual Server

69.1 - 1.3

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)

Version	Not Before
1.3	-

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

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

Example HTTP response

Response 202

69.2 - 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 (SUPPORTED)

Version	Not Before
1.2	20260831

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

Request header

"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

69.3 - 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

Request header

"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

69.4 - 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

Request header

"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

70 - Reboot Virtual Server

70.1 - 1.3

post /v1/servers/{server_id}/reboot

Description

Reboot Virtual Server.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

Request body

{
    "reboot_type": "SOFT"
}

Example HTTP response

Response 202

70.2 - 1.2

post /v1/servers/{server_id}/reboot

Description

Reboot Virtual Server.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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

Request header

"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

70.3 - 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

Request header

"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

70.4 - 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

Request header

"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

71 - Rebuild Virtual Server

71.1 - 1.3

post /v1/servers/{server_id}/rebuild

Description

Rebuild Virtual Server.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

Example HTTP response

Response 202

71.2 - 1.2

post /v1/servers/{server_id}/rebuild

Description

Rebuild Virtual Server.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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

Request header

"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

71.3 - 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

Request header

"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

71.4 - 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

Request header

"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

72 - Revert Volume to snapshot

72.1 - 1.3

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)

Version	Not Before
1.3	-

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

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

Request body

{
    "snapshot_id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790"
}

Example HTTP response

Response 202

72.2 - 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 (SUPPORTED)

Version	Not Before
1.2	20260831

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

Request header

"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

72.3 - 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

Request header

"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

72.4 - 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

Request header

"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

73 - Set Volume Qos

73.1 - 1.3

put /v1/volumes/{volume_id}/qos

Description

Set Volume Qos

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

Request body

{
    "max_iops": 10000,
    "max_throughput": 500
}

Example HTTP response

Response 202

73.2 - 1.2

put /v1/volumes/{volume_id}/qos

Description

Set Volume Qos

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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

Request header

"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

74 - Show a snapshot’s details

74.1 - 1.3

get /v1/snapshots/{snapshot_id}

Description

Show a snapshot’s details.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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
200	OK	SnapshotDetailResponse
400	Bad Request	None
401	Unauthorized	None

Example HTTP request

Request path

/v1/snapshots/{snapshot_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

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"
}

74.2 - 1.2

get /v1/snapshots/{snapshot_id}

Description

Show a snapshot’s details.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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
200	OK	SnapshotDetailResponse
400	Bad Request	None
401	Unauthorized	None

Example HTTP request

Request path

/v1/snapshots/{snapshot_id}

Request header

"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"
}

74.3 - 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

HTTP Code	Description	Schema
200	OK	SnapshotDetailResponse
400	Bad Request	None
401	Unauthorized	None

Example HTTP request

Request path

/v1/snapshots/{snapshot_id}

Request header

"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"
}

74.4 - 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

HTTP Code	Description	Schema
200	OK	SnapshotDetailResponse
400	Bad Request	None
401	Unauthorized	None

Example HTTP request

Request path

/v1/snapshots/{snapshot_id}

Request header

"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"
}

75 - Show Auto-Scaling Group

75.1 - 1.3

get /v1/auto-scaling-groups/{auto_scaling_group_id}

Description

Show Auto-Scaling Group.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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
200	OK	AutoScalingGroupShowResponseV1Dot2
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/auto-scaling-groups/{auto_scaling_group_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

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"
}

75.2 - 1.2

get /v1/auto-scaling-groups/{auto_scaling_group_id}

Description

Show Auto-Scaling Group.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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
200	OK	AutoScalingGroupShowResponseV1Dot2
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/auto-scaling-groups/{auto_scaling_group_id}

Request header

"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"
}

75.3 - 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

HTTP Code	Description	Schema
200	OK	AutoScalingGroupShowResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/auto-scaling-groups/{auto_scaling_group_id}

Request header

"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"
}

75.4 - 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

HTTP Code	Description	Schema
200	OK	AutoScalingGroupShowResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/auto-scaling-groups/{auto_scaling_group_id}

Request header

"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"
}

76 - Show Auto-Scaling Group Notification

76.1 - 1.3

get /v1/auto-scaling-groups/{auto_scaling_group_id}/notifications/{notification_id}

Description

Show Auto-Scaling Group notification.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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
200	OK	AutoScalingGroupNotificationShowResponse
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}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

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"
}

76.2 - 1.2

get /v1/auto-scaling-groups/{auto_scaling_group_id}/notifications/{notification_id}

Description

Show Auto-Scaling Group notification.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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
200	OK	AutoScalingGroupNotificationShowResponse
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}

Request header

"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"
}

76.3 - 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

HTTP Code	Description	Schema
200	OK	AutoScalingGroupNotificationShowResponse
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}

Request header

"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"
}

76.4 - 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

HTTP Code	Description	Schema
200	OK	AutoScalingGroupNotificationShowResponse
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}

Request header

"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"
}

77 - Show Auto-Scaling Group Policy

77.1 - 1.3

get /v1/auto-scaling-groups/{auto_scaling_group_id}/policies/{policy_id}

Description

Show Auto-Scaling Group policy.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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
200	OK	AutoScalingGroupPolicyShowResponse
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}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

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": "%"
}

77.2 - 1.2

get /v1/auto-scaling-groups/{auto_scaling_group_id}/policies/{policy_id}

Description

Show Auto-Scaling Group policy.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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
200	OK	AutoScalingGroupPolicyShowResponse
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}

Request header

"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": "%"
}

77.3 - 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

HTTP Code	Description	Schema
200	OK	AutoScalingGroupPolicyShowResponse
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}

Request header

"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": "%"
}

77.4 - 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

HTTP Code	Description	Schema
200	OK	AutoScalingGroupPolicyShowResponse
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}

Request header

"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": "%"
}

78 - Show Auto-Scaling Group Schedule

78.1 - 1.3

get /v1/auto-scaling-groups/{auto_scaling_group_id}/schedules/{schedule_id}

Description

Show Auto-Scaling Group schedule.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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
200	OK	AutoScalingGroupScheduleShowResponse
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}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

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"
}

78.2 - 1.2

get /v1/auto-scaling-groups/{auto_scaling_group_id}/schedules/{schedule_id}

Description

Show Auto-Scaling Group schedule.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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
200	OK	AutoScalingGroupScheduleShowResponse
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}

Request header

"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"
}

78.3 - 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

HTTP Code	Description	Schema
200	OK	AutoScalingGroupScheduleShowResponse
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}

Request header

"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"
}

78.4 - 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

HTTP Code	Description	Schema
200	OK	AutoScalingGroupScheduleShowResponse
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}

Request header

"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"
}

79 - Show default Volume type’s details

79.1 - 1.3

get /v1/volume-types/default

Description

Show a default Volume type’s details.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Responses

HTTP Code	Description	Schema
200	OK	VolumeTypeDetailResponse
401	Unauthorized	None
500	Internal Server Error	None

Example HTTP request

Request path

/v1/volume-types/default

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

Example HTTP response

Response 200

{
    "description": "Volume type description",
    "extra_specs": {
        "multiattach": "<is> True"
    },
    "id": "c643ac35-3aec-43e6-b97a-3d6f666c5207",
    "name": "SSD"
}

79.2 - 1.2

get /v1/volume-types/default

Description

Show a default Volume type’s details.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

Responses

HTTP Code	Description	Schema
200	OK	VolumeTypeDetailResponse
401	Unauthorized	None
500	Internal Server Error	None

Example HTTP request

Request path

/v1/volume-types/default

Request header

"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"
}

79.3 - 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

HTTP Code	Description	Schema
200	OK	VolumeTypeDetailResponse
401	Unauthorized	None
500	Internal Server Error	None

Example HTTP request

Request path

/v1/volume-types/default

Request header

"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"
}

79.4 - 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

HTTP Code	Description	Schema
200	OK	VolumeTypeDetailResponse
401	Unauthorized	None
500	Internal Server Error	None

Example HTTP request

Request path

/v1/volume-types/default

Request header

"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"
}

80 - Show Image

80.1 - 1.3

get /v1/images/{image_id}

Description

Show Image.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

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}]"
}

80.2 - 1.2

get /v1/images/{image_id}

Description

Show Image.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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}

Request header

"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}]"
}

80.3 - 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}

Request header

"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}]"
}

80.4 - 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}

Request header

"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}]"
}

81 - Show Image member

81.1 - 1.3

get /v1/images/{image_id}/members/{member_id}

Description

Show Image member.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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
200	OK	ImageMemberShowResponse
400	Bad Request	None
401	Unauthorized	None
404	Not Found	None

Example HTTP request

Request path

/v1/images/{image_id}/members/{member_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

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"
}

81.2 - 1.2

get /v1/images/{image_id}/members/{member_id}

Description

Show Image member.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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
200	OK	ImageMemberShowResponse
400	Bad Request	None
401	Unauthorized	None
404	Not Found	None

Example HTTP request

Request path

/v1/images/{image_id}/members/{member_id}

Request header

"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"
}

81.3 - 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

HTTP Code	Description	Schema
200	OK	ImageMemberShowResponse
400	Bad Request	None
401	Unauthorized	None
404	Not Found	None

Example HTTP request

Request path

/v1/images/{image_id}/members/{member_id}

Request header

"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"
}

81.4 - 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

HTTP Code	Description	Schema
200	OK	ImageMemberShowResponse
400	Bad Request	None
401	Unauthorized	None
404	Not Found	None

Example HTTP request

Request path

/v1/images/{image_id}/members/{member_id}

Request header

"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"
}

82 - Show Keypair

82.1 - 1.3

get /v1/keypairs/{keypair_name}

Description

Show keypair.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

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"
}

82.2 - 1.2

get /v1/keypairs/{keypair_name}

Description

Show keypair.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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}

Request header

"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"
}

82.3 - 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}

Request header

"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"
}

82.4 - 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}

Request header

"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"
}

83 - Show Launch Configuration

83.1 - 1.3

get /v1/launch-configurations/{launch_configuration_id}

Description

Show Launch Configuration.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	launch_configuration_id required	Launch Configuration ID Example : `b5aea5a675fc4f6b9e0fcd1288354c5f`	string	None

Responses

HTTP Code	Description	Schema
200	OK	LaunchConfigurationDetailShowResponseV1Dot2
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}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

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"
        }
    ]
}

83.2 - 1.2

get /v1/launch-configurations/{launch_configuration_id}

Description

Show Launch Configuration.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

Parameters

Type	Name	Description	Schema	Default
path	launch_configuration_id required	Launch Configuration ID Example : `b5aea5a675fc4f6b9e0fcd1288354c5f`	string	None

Responses

HTTP Code	Description	Schema
200	OK	LaunchConfigurationDetailShowResponseV1Dot2
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}

Request header

"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"
        }
    ]
}

83.3 - 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

HTTP Code	Description	Schema
200	OK	LaunchConfigurationDetailShowResponse
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}

Request header

"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"
        }
    ]
}

83.4 - 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

HTTP Code	Description	Schema
200	OK	LaunchConfigurationDetailShowResponse
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}

Request header

"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"
        }
    ]
}

84 - Show Server Group

84.1 - 1.3

get /v1/server-groups/{server_group_id}

Description

Show server group.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

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"
}

84.2 - 1.2

get /v1/server-groups/{server_group_id}

Description

Show server group.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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}

Request header

"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"
}

84.3 - 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}

Request header

"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"
}

84.4 - 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}

Request header

"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"
}

85 - Show Server Interface

85.1 - 1.3

get /v1/servers/{server_id}/interfaces/{port_id}

Description

Show Server Interface.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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	ServerInterfaceListResponseV1Dot2
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/servers/{server_id}/interfaces/{port_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

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"
        }
    ]
}

85.2 - 1.2

get /v1/servers/{server_id}/interfaces/{port_id}

Description

Show Server Interface.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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	ServerInterfaceListResponseV1Dot2
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/servers/{server_id}/interfaces/{port_id}

Request header

"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"
        }
    ]
}

85.3 - 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

HTTP Code	Description	Schema
200	OK	ServerInterfaceListResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/servers/{server_id}/interfaces/{port_id}

Request header

"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"
        }
    ]
}

85.4 - 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

HTTP Code	Description	Schema
200	OK	ServerInterfaceListResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/servers/{server_id}/interfaces/{port_id}

Request header

"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"
        }
    ]
}

86 - Show Server Ip

86.1 - 1.3

get /v1/servers/{server_id}/ips/{subnet_id}

Description

Show Server Ip.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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

HTTP Code	Description	Schema
200	OK	ServerShowResponseAddress
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/servers/{server_id}/ips/{subnet_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

Example HTTP response

Response 200

{
    "ip_addresses": [
        {
            "ip_address": "192.169.3.2",
            "version": 4
        }
    ],
    "subnet_name": "subnetname"
}

86.2 - 1.2

get /v1/servers/{server_id}/ips/{subnet_id}

Description

Show Server Ip.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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

HTTP Code	Description	Schema
200	OK	ServerShowResponseAddress
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/servers/{server_id}/ips/{subnet_id}

Request header

"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"
}

86.3 - 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

HTTP Code	Description	Schema
200	OK	ServerShowResponseAddress
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/servers/{server_id}/ips/{subnet_id}

Request header

"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"
}

86.4 - 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

HTTP Code	Description	Schema
200	OK	ServerShowResponseAddress
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/servers/{server_id}/ips/{subnet_id}

Request header

"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"
}

87 - Show Server Quota Set

87.1 - 1.3

get /v1/quota-sets

Description

Show server quota Set.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Responses

HTTP Code	Description	Schema
200	OK	ServerQuotaSet
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/quota-sets

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

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
    }
}

87.2 - 1.2

get /v1/quota-sets

Description

Show server quota Set.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

Responses

HTTP Code	Description	Schema
200	OK	ServerQuotaSet
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/quota-sets

Request header

"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
    }
}

87.3 - 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

Request header

"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
    }
}

87.4 - 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

Request header

"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
    }
}

88 - Show Server Type

88.1 - 1.3

get /v1/server-types/{server_type_id}

Description

Show server type.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

Example HTTP response

Response 200

{
    "description": "description",
    "disk": 100,
    "ephemeral": 0,
    "extra_specs": "",
    "id": "s1v1m2",
    "name": "s1v1m2",
    "ram": 2,
    "swap": 0,
    "vcpus": 1
}

88.2 - 1.2

get /v1/server-types/{server_type_id}

Description

Show server type.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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}

Request header

"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
}

88.3 - 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}

Request header

"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
}

88.4 - 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}

Request header

"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
}

89 - Show Server Volume

89.1 - 1.3

get /v1/servers/{server_id}/volumes/{volume_id}

Description

Show Server Volume.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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
200	OK	ServersVolumeResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/servers/{server_id}/volumes/{volume_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

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"
}

89.2 - 1.2

get /v1/servers/{server_id}/volumes/{volume_id}

Description

Show Server Volume.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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
200	OK	ServersVolumeResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/servers/{server_id}/volumes/{volume_id}

Request header

"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"
}

89.3 - 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

HTTP Code	Description	Schema
200	OK	ServersVolumeResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/servers/{server_id}/volumes/{volume_id}

Request header

"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"
}

89.4 - 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

HTTP Code	Description	Schema
200	OK	ServersVolumeResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/servers/{server_id}/volumes/{volume_id}

Request header

"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"
}

90 - Show Virtual Server

90.1 - 1.3

get /v1/servers/{server_id}

Description

Show Virtual Server.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

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": "2024-01-15T10:30:00.000Z",
    "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": "2024-01-15T10:30:00.000Z",
    "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"
}

90.2 - 1.2

get /v1/servers/{server_id}

Description

Show Virtual Server.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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}

Request header

"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": "2024-01-15T10:30:00.000Z",
    "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": "2024-01-15T10:30:00.000Z",
    "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"
}

90.3 - 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}

Request header

"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": "2024-01-15T10:30:00.000Z",
    "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": "2024-01-15T10:30:00.000Z",
    "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"
}

90.4 - 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}

Request header

"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": "2024-01-15T10:30:00.000Z",
    "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": "2024-01-15T10:30:00.000Z",
    "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"
}

91 - Show Virtual Server Console Log

91.1 - 1.3

get /v1/servers/{server_id}/console-log

Description

Show Virtual Server Console Log.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

Example HTTP response

Response 200

{
    "output": "FAKE CONSOLE OUTPUT"
}

91.2 - 1.2

get /v1/servers/{server_id}/console-log

Description

Show Virtual Server Console Log.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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

Request header

"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"
}

91.3 - 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

Request header

"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"
}

91.4 - 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

Request header

"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"
}

92 - Show Virtual Server Password

92.1 - 1.3

post /v1/servers/{server_id}/password

Description

Show Virtual Server Password.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

Request body

{
    "private_key": "-----BEGIN RSA PRIVATE KEY-----\nfakeKey\n-----END RSA PRIVATE KEY-----"
}

Example HTTP response

Response 200

{
    "password": "password"
}

92.2 - 1.2

post /v1/servers/{server_id}/password

Description

Show Virtual Server Password.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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

Request header

"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"
}

92.3 - 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

Request header

"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"
}

92.4 - 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

Request header

"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"
}

93 - Show Volume Quota Set

93.1 - 1.3

get /v1/volumes/quota-sets

Description

Show volume quota set.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Responses

HTTP Code	Description	Schema
200	OK	VolumeQuotaSet
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/volumes/quota-sets

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

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
    }
}

93.2 - 1.2

get /v1/volumes/quota-sets

Description

Show volume quota set.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

Responses

HTTP Code	Description	Schema
200	OK	VolumeQuotaSet
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/volumes/quota-sets

Request header

"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
    }
}

93.3 - 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

Request header

"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
    }
}

93.4 - 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

Request header

"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
    }
}

94 - Show volume transfer detail

94.1 - 1.3

get /v1/volume-transfer/{transfer_id}

Description

Show volume transfer detail.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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
200	OK	VolumeTransferShowResponse
400	Bad Request	None
401	Unauthorized	None

Example HTTP request

Request path

/v1/volume-transfer/{transfer_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

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"
}

94.2 - 1.2

get /v1/volume-transfer/{transfer_id}

Description

Show volume transfer detail.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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
200	OK	VolumeTransferShowResponse
400	Bad Request	None
401	Unauthorized	None

Example HTTP request

Request path

/v1/volume-transfer/{transfer_id}

Request header

"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"
}

94.3 - 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

HTTP Code	Description	Schema
200	OK	VolumeTransferShowResponse
400	Bad Request	None
401	Unauthorized	None

Example HTTP request

Request path

/v1/volume-transfer/{transfer_id}

Request header

"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"
}

94.4 - 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

HTTP Code	Description	Schema
200	OK	VolumeTransferShowResponse
400	Bad Request	None
401	Unauthorized	None

Example HTTP request

Request path

/v1/volume-transfer/{transfer_id}

Request header

"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"
}

95 - Show Volume type’s details

95.1 - 1.3

get /v1/volume-types/{volume_type_id}

Description

Show a Volume type’s details.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

Example HTTP response

Response 200

{
    "description": "Volume type description",
    "extra_specs": {
        "multiattach": "<is> True"
    },
    "id": "c643ac35-3aec-43e6-b97a-3d6f666c5207",
    "name": "SSD"
}

95.2 - 1.2

get /v1/volume-types/{volume_type_id}

Description

Show a Volume type’s details.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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}

Request header

"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"
}

95.3 - 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}

Request header

"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"
}

95.4 - 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}

Request header

"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"
}

96 - Show Volume's details

96.1 - 1.3

get /v1/volumes/{volume_id}

Description

Show a Volume’s details.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume ID Example : `3f500f00-ed80-4566-a057-e31760226f9a`	string	None

Responses

HTTP Code	Description	Schema
200	OK	VolumeShowResponseV1Dot2
400	Bad Request	None
401	Unauthorized	None

Example HTTP request

Request path

/v1/volumes/{volume_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

Example HTTP response

Response 200

{
    "bootable": false,
    "created_at": "2024-01-15T10:30:00.000Z",
    "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": "2024-01-15T10:30:00.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"
}

96.2 - 1.2

get /v1/volumes/{volume_id}

Description

Show a Volume’s details.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume ID Example : `3f500f00-ed80-4566-a057-e31760226f9a`	string	None

Responses

HTTP Code	Description	Schema
200	OK	VolumeShowResponseV1Dot2
400	Bad Request	None
401	Unauthorized	None

Example HTTP request

Request path

/v1/volumes/{volume_id}

Request header

"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": "2024-01-15T10:30:00.000Z",
    "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": "2024-01-15T10:30:00.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"
}

96.3 - 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

HTTP Code	Description	Schema
200	OK	VolumeShowResponse
400	Bad Request	None
401	Unauthorized	None

Example HTTP request

Request path

/v1/volumes/{volume_id}

Request header

"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": "2024-01-15T10:30:00.000Z",
    "encrypted": true,
    "id": "3f500f00-ed80-4566-a057-e31760226f9a",
    "modified_at": "2025-07-26T12:00:00Z",
    "multiattach": false,
    "name": "volume01",
    "servers": [
        {
            "attached_at": "2024-01-15T10:30:00.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"
}

96.4 - 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

HTTP Code	Description	Schema
200	OK	VolumeShowResponse
400	Bad Request	None
401	Unauthorized	None

Example HTTP request

Request path

/v1/volumes/{volume_id}

Request header

"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": "2024-01-15T10:30:00.000Z",
    "encrypted": true,
    "id": "3f500f00-ed80-4566-a057-e31760226f9a",
    "modified_at": "2025-07-26T12:00:00Z",
    "multiattach": false,
    "name": "volume01",
    "servers": [
        {
            "attached_at": "2024-01-15T10:30:00.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"
}

97 - Start Virtual Server

97.1 - 1.3

post /v1/servers/{server_id}/start

Description

Start Virtual Server.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

Example HTTP response

Response 202

97.2 - 1.2

post /v1/servers/{server_id}/start

Description

Start Virtual Server.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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

Request header

"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

97.3 - 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

Request header

"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

97.4 - 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

Request header

"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

98 - Stop Virtual Server

98.1 - 1.3

post /v1/servers/{server_id}/stop

Description

Stop Virtual Server.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

Example HTTP response

Response 202

98.2 - 1.2

post /v1/servers/{server_id}/stop

Description

Stop Virtual Server.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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

Request header

"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

98.3 - 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

Request header

"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

98.4 - 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

Request header

"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

99 - Unlock Virtual Server

99.1 - 1.3

post /v1/servers/{server_id}/unlock

Description

Unlock Virtual Server.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

Example HTTP response

Response 202

99.2 - 1.2

post /v1/servers/{server_id}/unlock

Description

Unlock Virtual Server.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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

Request header

"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

99.3 - 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

Request header

"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

99.4 - 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

Request header

"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

100 - Update a snapshot

100.1 - 1.3

put /v1/snapshots/{snapshot_id}

Description

Update a snapshot.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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

HTTP Code	Description	Schema
200	OK	SnapshotDetailResponse
400	Bad Request	None
401	Unauthorized	None

Example HTTP request

Request path

/v1/snapshots/{snapshot_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

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"
}

100.2 - 1.2

put /v1/snapshots/{snapshot_id}

Description

Update a snapshot.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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

HTTP Code	Description	Schema
200	OK	SnapshotDetailResponse
400	Bad Request	None
401	Unauthorized	None

Example HTTP request

Request path

/v1/snapshots/{snapshot_id}

Request header

"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"
}

100.3 - 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

HTTP Code	Description	Schema
200	OK	SnapshotDetailResponse
400	Bad Request	None
401	Unauthorized	None

Example HTTP request

Request path

/v1/snapshots/{snapshot_id}

Request header

"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"
}

100.4 - 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

HTTP Code	Description	Schema
200	OK	SnapshotDetailResponse
400	Bad Request	None
401	Unauthorized	None

Example HTTP request

Request path

/v1/snapshots/{snapshot_id}

Request header

"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"
}

101 - Update Auto-Scaling Group

101.1 - 1.3

put /v1/auto-scaling-groups/{auto_scaling_group_id}

Description

Update Auto-Scaling Group.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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

HTTP Code	Description	Schema
200	OK	AutoScalingGroupShowResponseV1Dot2
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}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

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"
}

101.2 - 1.2

put /v1/auto-scaling-groups/{auto_scaling_group_id}

Description

Update Auto-Scaling Group.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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

HTTP Code	Description	Schema
200	OK	AutoScalingGroupShowResponseV1Dot2
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}

Request header

"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"
}

101.3 - 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

HTTP Code	Description	Schema
200	OK	AutoScalingGroupShowResponse
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}

Request header

"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"
}

101.4 - 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

HTTP Code	Description	Schema
200	OK	AutoScalingGroupShowResponse
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}

Request header

"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"
}

102 - Update Auto-Scaling Group LB Server Groups

102.1 - 1.3

put /v1/auto-scaling-groups/{auto_scaling_group_id}/lb-server-groups

Description

Update Auto-Scaling Group LB Server Groups.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	auto_scaling_group_id required	Auto-Scaling Group ID Example : `52613bd852b04b39adcb15a8364d856d`	string	None
body	body required		AutoScalingGroupLbServerGroupSetRequest

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

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

Request body

{
    "lb_server_groups": [
        {
            "id": "d06e87d3-ca9a-461b-8e88-077a542a7335",
            "port": 8080
        }
    ]
}

Example HTTP response

Response 202

102.2 - 1.2

put /v1/auto-scaling-groups/{auto_scaling_group_id}/lb-server-groups

Description

Update Auto-Scaling Group LB Server Groups.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

Parameters

Type	Name	Description	Schema	Default
path	auto_scaling_group_id required	Auto-Scaling Group ID Example : `52613bd852b04b39adcb15a8364d856d`	string	None
body	body required		AutoScalingGroupLbServerGroupSetRequest

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

Request header

"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

102.3 - 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

Type	Name	Description	Schema	Default
path	auto_scaling_group_id required	Auto-Scaling Group ID Example : `52613bd852b04b39adcb15a8364d856d`	string	None
body	body required		AutoScalingGroupLbServerGroupSetRequest

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

Request header

"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

102.4 - 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

Type	Name	Description	Schema	Default
path	auto_scaling_group_id required	Auto-Scaling Group ID Example : `52613bd852b04b39adcb15a8364d856d`	string	None
body	body required		AutoScalingGroupLbServerGroupSetRequest

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

Request header

"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

103 - Update Auto-Scaling Group Notification

103.1 - 1.3

put /v1/auto-scaling-groups/{auto_scaling_group_id}/notifications/{notification_id}

Description

Update Auto-Scaling Group notification.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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

HTTP Code	Description	Schema
200	OK	AutoScalingGroupNotificationShowResponse
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}/notifications/{notification_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

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"
}

103.2 - 1.2

put /v1/auto-scaling-groups/{auto_scaling_group_id}/notifications/{notification_id}

Description

Update Auto-Scaling Group notification.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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

HTTP Code	Description	Schema
200	OK	AutoScalingGroupNotificationShowResponse
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}/notifications/{notification_id}

Request header

"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"
}

103.3 - 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

HTTP Code	Description	Schema
200	OK	AutoScalingGroupNotificationShowResponse
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}/notifications/{notification_id}

Request header

"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"
}

103.4 - 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

HTTP Code	Description	Schema
200	OK	AutoScalingGroupNotificationShowResponse
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}/notifications/{notification_id}

Request header

"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"
}

104 - Update Auto-Scaling Group Policy

104.1 - 1.3

put /v1/auto-scaling-groups/{auto_scaling_group_id}/policies/{policy_id}

Description

Update Auto-Scaling Group policy.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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

HTTP Code	Description	Schema
200	OK	AutoScalingGroupPolicyShowResponse
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}/policies/{policy_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

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": "%"
}

104.2 - 1.2

put /v1/auto-scaling-groups/{auto_scaling_group_id}/policies/{policy_id}

Description

Update Auto-Scaling Group policy.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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

HTTP Code	Description	Schema
200	OK	AutoScalingGroupPolicyShowResponse
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}/policies/{policy_id}

Request header

"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": "%"
}

104.3 - 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

HTTP Code	Description	Schema
200	OK	AutoScalingGroupPolicyShowResponse
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}/policies/{policy_id}

Request header

"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": "%"
}

104.4 - 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

HTTP Code	Description	Schema
200	OK	AutoScalingGroupPolicyShowResponse
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}/policies/{policy_id}

Request header

"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": "%"
}

105 - Update Auto-Scaling Group Schedule

105.1 - 1.3

put /v1/auto-scaling-groups/{auto_scaling_group_id}/schedules/{schedule_id}

Description

Update Auto-Scaling Group schedule.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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

HTTP Code	Description	Schema
200	OK	AutoScalingGroupScheduleShowResponse
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}/schedules/{schedule_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

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"
}

105.2 - 1.2

put /v1/auto-scaling-groups/{auto_scaling_group_id}/schedules/{schedule_id}

Description

Update Auto-Scaling Group schedule.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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

HTTP Code	Description	Schema
200	OK	AutoScalingGroupScheduleShowResponse
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}/schedules/{schedule_id}

Request header

"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"
}

105.3 - 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

HTTP Code	Description	Schema
200	OK	AutoScalingGroupScheduleShowResponse
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}/schedules/{schedule_id}

Request header

"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"
}

105.4 - 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

HTTP Code	Description	Schema
200	OK	AutoScalingGroupScheduleShowResponse
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}/schedules/{schedule_id}

Request header

"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"
}

106 - Update Auto-Scaling Group server count

106.1 - 1.3

put /v1/auto-scaling-groups/{auto_scaling_group_id}/server-count

Description

Update Auto-Scaling Group server count.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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

HTTP Code	Description	Schema
200	OK	AutoScalingGroupShowResponseV1Dot2
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}/server-count

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

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"
}

106.2 - 1.2

put /v1/auto-scaling-groups/{auto_scaling_group_id}/server-count

Description

Update Auto-Scaling Group server count.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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

HTTP Code	Description	Schema
200	OK	AutoScalingGroupShowResponseV1Dot2
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}/server-count

Request header

"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"
}

106.3 - 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

HTTP Code	Description	Schema
200	OK	AutoScalingGroupShowResponse
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}/server-count

Request header

"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"
}

106.4 - 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

HTTP Code	Description	Schema
200	OK	AutoScalingGroupShowResponse
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}/server-count

Request header

"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"
}

107 - Update Image

107.1 - 1.3

put /v1/images/{image_id}

Description

Update Image.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

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}]"
}

107.2 - 1.2

put /v1/images/{image_id}

Description

Update Image.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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}

Request header

"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}]"
}

107.3 - 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}

Request header

"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}]"
}

107.4 - 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}

Request header

"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}]"
}

108 - Update Image member

108.1 - 1.3

put /v1/images/{image_id}/members/{member_id}

Description

Update Image member.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

Request body

{
    "status": "pending"
}

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"
}

108.2 - 1.2

put /v1/images/{image_id}/members/{member_id}

Description

Update Image member.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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}

Request header

"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

{
    "status": "pending"
}

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"
}

108.3 - 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}

Request header

"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

{
    "status": "pending"
}

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"
}

108.4 - 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}

Request header

"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

{
    "status": "pending"
}

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"
}

109 - Update Server Interface

109.1 - 1.3

put /v1/servers/{server_id}/interfaces/{port_id}

Description

Update Server Interface.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

Request body

{
    "fixed_ip_address": "192.169.3.2",
    "subnet_id": ""
}

Example HTTP response

Response 202

109.2 - 1.2

put /v1/servers/{server_id}/interfaces/{port_id}

Description

Update Server Interface.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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}

Request header

"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

109.3 - 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}

Request header

"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

109.4 - 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}

Request header

"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

110 - Update Server Volume

110.1 - 1.3

put /v1/servers/{server_id}/volumes/{volume_id}

Description

Update Server Volume.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

Request body

{
    "delete_on_termination": false,
    "volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}

Example HTTP response

Response 200

110.2 - 1.2

put /v1/servers/{server_id}/volumes/{volume_id}

Description

Update Server Volume.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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}

Request header

"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

110.3 - 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}

Request header

"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

110.4 - 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}

Request header

"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

111 - Update Virtual Server

111.1 - 1.3

put /v1/servers/{server_id}

Description

Update Virtual Server.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

Request body

{
    "name": "servername"
}

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": "2024-01-15T10:30:00.000Z",
    "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": "2024-01-15T10:30:00.000Z",
    "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"
}

111.2 - 1.2

put /v1/servers/{server_id}

Description

Update Virtual Server.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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}

Request header

"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": "servername"
}

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": "2024-01-15T10:30:00.000Z",
    "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": "2024-01-15T10:30:00.000Z",
    "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"
}

111.3 - 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}

Request header

"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": "servername"
}

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": "2024-01-15T10:30:00.000Z",
    "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": "2024-01-15T10:30:00.000Z",
    "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"
}

111.4 - 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}

Request header

"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": "servername"
}

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": "2024-01-15T10:30:00.000Z",
    "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": "2024-01-15T10:30:00.000Z",
    "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"
}

112 - Update Virtual Server type

112.1 - 1.3

post /v1/servers/{server_id}/server-type

Description

Update Virtual Server type

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

Request body

{
    "server_type": "s1v1m2"
}

Example HTTP response

Response 202

112.2 - 1.2

post /v1/servers/{server_id}/server-type

Description

Update Virtual Server type

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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

Request header

"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

112.3 - 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

Request header

"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

112.4 - 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

Request header

"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

113 - Update Volume

113.1 - 1.3

put /v1/volumes/{volume_id}

Description

Update a Volume.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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

HTTP Code	Description	Schema
200	OK	VolumeShowResponseV1Dot2
400	Bad Request	None
401	Unauthorized	None

Example HTTP request

Request path

/v1/volumes/{volume_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

Request body

{
    "name": "volume01"
}

Example HTTP response

Response 200

{
    "bootable": false,
    "created_at": "2024-01-15T10:30:00.000Z",
    "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": "2024-01-15T10:30:00.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"
}

113.2 - 1.2

put /v1/volumes/{volume_id}

Description

Update a Volume.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

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

HTTP Code	Description	Schema
200	OK	VolumeShowResponseV1Dot2
400	Bad Request	None
401	Unauthorized	None

Example HTTP request

Request path

/v1/volumes/{volume_id}

Request header

"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"
}

Example HTTP response

Response 200

{
    "bootable": false,
    "created_at": "2024-01-15T10:30:00.000Z",
    "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": "2024-01-15T10:30:00.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"
}

113.3 - 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

HTTP Code	Description	Schema
200	OK	VolumeShowResponse
400	Bad Request	None
401	Unauthorized	None

Example HTTP request

Request path

/v1/volumes/{volume_id}

Request header

"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"
}

Example HTTP response

Response 200

{
    "bootable": false,
    "created_at": "2024-01-15T10:30:00.000Z",
    "encrypted": true,
    "id": "3f500f00-ed80-4566-a057-e31760226f9a",
    "modified_at": "2025-07-26T12:00:00Z",
    "multiattach": false,
    "name": "volume01",
    "servers": [
        {
            "attached_at": "2024-01-15T10:30:00.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"
}

113.4 - 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

HTTP Code	Description	Schema
200	OK	VolumeShowResponse
400	Bad Request	None
401	Unauthorized	None

Example HTTP request

Request path

/v1/volumes/{volume_id}

Request header

"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"
}

Example HTTP response

Response 200

{
    "bootable": false,
    "created_at": "2024-01-15T10:30:00.000Z",
    "encrypted": true,
    "id": "3f500f00-ed80-4566-a057-e31760226f9a",
    "modified_at": "2025-07-26T12:00:00Z",
    "multiattach": false,
    "name": "volume01",
    "servers": [
        {
            "attached_at": "2024-01-15T10:30:00.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"
}