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

Return to the regular view of this page.

Compute

1: Bare Metal Server

1.1: CLIs

1.1.1: Assign Baremetal Private NAT IP

1.1.1.1: 1.1

1.1.2: Assign Baremetal Public NAT IP

1.1.2.1: 1.1
1.1.2.2: 1.0

1.1.3: Attach Baremetal Local Subnet

1.1.3.1: 1.1
1.1.3.2: 1.0

1.1.4: Create Baremetals

1.1.4.1: 1.1
1.1.4.2: 1.0

1.1.5: Delete Baremetal Private NAT IP

1.1.5.1: 1.1

1.1.6: Delete Baremetal Public NAT IP

1.1.6.1: 1.1
1.1.6.2: 1.0

1.1.7: Delete Baremetals

1.1.7.1: 1.1
1.1.7.2: 1.0

1.1.8: Detach Baremetal Local Subnet

1.1.8.1: 1.1
1.1.8.2: 1.0

1.1.9: List Baremetal Images

1.1.9.1: 1.1
1.1.9.2: 1.0

1.1.10: List Baremetal Products

1.1.10.1: 1.1
1.1.10.2: 1.0

1.1.11: List Baremetals

1.1.11.1: 1.1
1.1.11.2: 1.0

1.1.12: Lock Baremetal

1.1.12.1: 1.1
1.1.12.2: 1.0

1.1.13: Show Baremetal

1.1.13.1: 1.1
1.1.13.2: 1.0

1.1.14: Start Baremetals

1.1.14.1: 1.1
1.1.14.2: 1.0

1.1.15: Stop Baremetals

1.1.15.1: 1.1
1.1.15.2: 1.0

1.1.16: Unlock Baremetal

1.1.16.1: 1.1
1.1.16.2: 1.0

2: Cloud Functions

2.1: CLIs

2.1.1: Approve PrivateLink Endpoint

2.1.1.1: 1.3
2.1.1.2: 1.2

2.1.2: Check Function Name Duplication

2.1.2.1: 1.3
2.1.2.2: 1.2
2.1.2.3: 1.1
2.1.2.4: 1.0

2.1.3: Connect PrivateLink Endpoint

2.1.3.1: 1.3
2.1.3.2: 1.2

2.1.4: Create Cloud Function

2.1.4.1: 1.3
2.1.4.2: 1.2
2.1.4.3: 1.1
2.1.4.4: 1.0

2.1.5: Create Cloud Function Apigateway Trigger

2.1.5.1: 1.3
2.1.5.2: 1.2
2.1.5.3: 1.1
2.1.5.4: 1.0

2.1.6: Create Cloud Function Cronjob Trigger

2.1.6.1: 1.3
2.1.6.2: 1.2
2.1.6.3: 1.1
2.1.6.4: 1.0

2.1.7: Create PrivateLink Endpoint

2.1.7.1: 1.3
2.1.7.2: 1.2

2.1.8: Delete Cloud Function

2.1.8.1: 1.3
2.1.8.2: 1.2
2.1.8.3: 1.1
2.1.8.4: 1.0

2.1.9: Delete Cloud Function Trigger

2.1.9.1: 1.3
2.1.9.2: 1.2
2.1.9.3: 1.1
2.1.9.4: 1.0

2.1.10: Delete PrivateLink Endpoint

2.1.10.1: 1.3
2.1.10.2: 1.2

2.1.11: Delete Resource Policy

2.1.11.1: 1.3

2.1.12: List Cloud Function Triggers

2.1.12.1: 1.3
2.1.12.2: 1.2
2.1.12.3: 1.1
2.1.12.4: 1.0

2.1.13: List Cloud Functions

2.1.13.1: 1.3
2.1.13.2: 1.2
2.1.13.3: 1.1
2.1.13.4: 1.0

2.1.14: List Environment Variables

2.1.14.1: 1.3

2.1.15: List PrivateLink Endpoint

2.1.15.1: 1.3

2.1.16: List Runtimes

2.1.16.1: 1.3
2.1.16.2: 1.2
2.1.16.3: 1.1
2.1.16.4: 1.0

2.1.17: List Sample Codes

2.1.17.1: 1.3
2.1.17.2: 1.2
2.1.17.3: 1.1
2.1.17.4: 1.0

2.1.18: Request PrivateLink Endpoint

2.1.18.1: 1.3
2.1.18.2: 1.2

2.1.19: Set Resource Policy

2.1.19.1: 1.3

2.1.20: Show Cloud Function

2.1.20.1: 1.3
2.1.20.2: 1.2
2.1.20.3: 1.1
2.1.20.4: 1.0

2.1.21: Show Cloud Function Code

2.1.21.1: 1.3
2.1.21.2: 1.2
2.1.21.3: 1.1
2.1.21.4: 1.0

2.1.22: Show Cloud Function Configuration

2.1.22.1: 1.3
2.1.22.2: 1.2
2.1.22.3: 1.1
2.1.22.4: 1.0

2.1.23: Show Cloud Function Logs

2.1.23.1: 1.3
2.1.23.2: 1.2
2.1.23.3: 1.1
2.1.23.4: 1.0

2.1.24: Show Cloud Function Metrics

2.1.24.1: 1.3
2.1.24.2: 1.2
2.1.24.3: 1.1
2.1.24.4: 1.0

2.1.25: Show Cloud Function Trigger

2.1.25.1: 1.3
2.1.25.2: 1.2
2.1.25.3: 1.1
2.1.25.4: 1.0

2.1.26: Show General Config

2.1.26.1: 1.3

2.1.27: Show PrivateLink Service

2.1.27.1: 1.3

2.1.28: Show Resource Policy

2.1.28.1: 1.3

2.1.29: Show Url Config

2.1.29.1: 1.3

2.1.30: Update Cloud Function Code

2.1.30.1: 1.3
2.1.30.2: 1.2
2.1.30.3: 1.1
2.1.30.4: 1.0

2.1.31: Update Cloud Function Code File

2.1.31.1: 1.3
2.1.31.2: 1.2
2.1.31.3: 1.1

2.1.32: Update Cloud Function Config

2.1.32.1: 1.3
2.1.32.2: 1.2
2.1.32.3: 1.1
2.1.32.4: 1.0

2.1.33: Update Cloud Function Cronjob Trigger

2.1.33.1: 1.3
2.1.33.2: 1.2
2.1.33.3: 1.1
2.1.33.4: 1.0

2.1.34: Update Cloud Function Url

2.1.34.1: 1.3
2.1.34.2: 1.2
2.1.34.3: 1.1
2.1.34.4: 1.0

2.1.35: Update Cloud Function Variables

2.1.35.1: 1.3
2.1.35.2: 1.2
2.1.35.3: 1.1
2.1.35.4: 1.0

2.1.36: Update PrivateLink Service

2.1.36.1: 1.3
2.1.36.2: 1.2

3: Virtual Server

3.1: CLIs

3.1.1: Accept a volume transfer

3.1.1.1: 1.2
3.1.1.2: 1.1
3.1.1.3: 1.0

3.1.2: Attach Virtual Server Security Group

3.1.2.1: 1.0

3.1.3: Attach Volume to Virtual Server

3.1.3.1: 1.2
3.1.3.2: 1.1
3.1.3.3: 1.0

3.1.4: Create a snapshot

3.1.4.1: 1.2
3.1.4.2: 1.1
3.1.4.3: 1.0

3.1.5: Create a volume transfer

3.1.5.1: 1.2
3.1.5.2: 1.1
3.1.5.3: 1.0

3.1.6: Create Auto-Scaling Group

3.1.6.1: 1.2
3.1.6.2: 1.1
3.1.6.3: 1.0

3.1.7: Create Auto-Scaling Group Notification

3.1.7.1: 1.2
3.1.7.2: 1.1
3.1.7.3: 1.0

3.1.8: Create Auto-Scaling Group Policy

3.1.8.1: 1.2
3.1.8.2: 1.1
3.1.8.3: 1.0

3.1.9: Create Auto-Scaling Group Schedule

3.1.9.1: 1.2
3.1.9.2: 1.1
3.1.9.3: 1.0

3.1.10: Create Image

3.1.10.1: 1.2
3.1.10.2: 1.1
3.1.10.3: 1.0

3.1.11: Create Image member

3.1.11.1: 1.2
3.1.11.2: 1.1
3.1.11.3: 1.0

3.1.12: Create Keypair

3.1.12.1: 1.2
3.1.12.2: 1.1
3.1.12.3: 1.0

3.1.13: Create Launch Configuration

3.1.13.1: 1.2
3.1.13.2: 1.1
3.1.13.3: 1.0

3.1.14: Create Server Group

3.1.14.1: 1.2
3.1.14.2: 1.1
3.1.14.3: 1.0

3.1.15: Create Server Interface

3.1.15.1: 1.2
3.1.15.2: 1.1
3.1.15.3: 1.0

3.1.16: Create Server Interface Nat

3.1.16.1: 1.2
3.1.16.2: 1.1
3.1.16.3: 1.0

3.1.17: Create Server Interface Private Nat

3.1.17.1: 1.2
3.1.17.2: 1.1
3.1.17.3: 1.0

3.1.18: Create Server Volume

3.1.18.1: 1.2
3.1.18.2: 1.1
3.1.18.3: 1.0

3.1.19: Create Sharing Image

3.1.19.1: 1.2
3.1.19.2: 1.1
3.1.19.3: 1.0

3.1.20: Create Virtual Server

3.1.20.1: 1.2
3.1.20.2: 1.1
3.1.20.3: 1.0

3.1.21: Create Virtual Server Custom Image

3.1.21.1: 1.2
3.1.21.2: 1.1
3.1.21.3: 1.0

3.1.22: Create Virtual Server Dump

3.1.22.1: 1.2
3.1.22.2: 1.1
3.1.22.3: 1.0

3.1.23: Create Volume

3.1.23.1: 1.2
3.1.23.2: 1.1
3.1.23.3: 1.0

3.1.24: Delete a snapshot

3.1.24.1: 1.2
3.1.24.2: 1.1
3.1.24.3: 1.0

3.1.25: Delete a volume transfer

3.1.25.1: 1.2
3.1.25.2: 1.1
3.1.25.3: 1.0

3.1.26: Delete Auto-Scaling Group

3.1.26.1: 1.2
3.1.26.2: 1.1
3.1.26.3: 1.0

3.1.27: Delete Auto-Scaling Group Notification

3.1.27.1: 1.2
3.1.27.2: 1.1
3.1.27.3: 1.0

3.1.28: Delete Auto-Scaling Group Policy

3.1.28.1: 1.2
3.1.28.2: 1.1
3.1.28.3: 1.0

3.1.29: Delete Auto-Scaling Group Schedule

3.1.29.1: 1.2
3.1.29.2: 1.1
3.1.29.3: 1.0

3.1.30: Delete Image

3.1.30.1: 1.2
3.1.30.2: 1.1
3.1.30.3: 1.0

3.1.31: Delete Image member

3.1.31.1: 1.2
3.1.31.2: 1.1
3.1.31.3: 1.0

3.1.32: Delete Keypair

3.1.32.1: 1.2
3.1.32.2: 1.1
3.1.32.3: 1.0

3.1.33: Delete Launch Configuration

3.1.33.1: 1.2
3.1.33.2: 1.1
3.1.33.3: 1.0

3.1.34: Delete Server Group

3.1.34.1: 1.2
3.1.34.2: 1.1
3.1.34.3: 1.0

3.1.35: Delete Server Interface

3.1.35.1: 1.2
3.1.35.2: 1.1
3.1.35.3: 1.0

3.1.36: Delete Server Interface Nat

3.1.36.1: 1.2
3.1.36.2: 1.1
3.1.36.3: 1.0

3.1.37: Delete Server Interface Private Nat

3.1.37.1: 1.2
3.1.37.2: 1.1
3.1.37.3: 1.0

3.1.38: Delete Server Volume

3.1.38.1: 1.2
3.1.38.2: 1.1
3.1.38.3: 1.0

3.1.39: Delete Virtual Server

3.1.39.1: 1.2
3.1.39.2: 1.1
3.1.39.3: 1.0

3.1.40: Delete Volume

3.1.40.1: 1.2
3.1.40.2: 1.1
3.1.40.3: 1.0

3.1.41: Detach Virtual Server Security Group

3.1.41.1: 1.0

3.1.42: Detach Volume from Virtual Server

3.1.42.1: 1.2
3.1.42.2: 1.1
3.1.42.3: 1.0

3.1.43: Extend Volume

3.1.43.1: 1.2
3.1.43.2: 1.1
3.1.43.3: 1.0

3.1.44: Get region's maximum partition size.

3.1.44.1: 1.2
3.1.44.2: 1.1
3.1.44.3: 1.0

3.1.45: Import Image

3.1.45.1: 1.2
3.1.45.2: 1.1
3.1.45.3: 1.0

3.1.46: List Auto-Scaling Group LB Server Groups

3.1.46.1: 1.2
3.1.46.2: 1.1
3.1.46.3: 1.0

3.1.47: List Auto-Scaling Group Notifications

3.1.47.1: 1.2
3.1.47.2: 1.1
3.1.47.3: 1.0

3.1.48: List Auto-Scaling Group Policies

3.1.48.1: 1.2
3.1.48.2: 1.1
3.1.48.3: 1.0

3.1.49: List Auto-Scaling Group Schedules

3.1.49.1: 1.2
3.1.49.2: 1.1
3.1.49.3: 1.0

3.1.50: List Auto-Scaling Group Virtual Servers

3.1.50.1: 1.2
3.1.50.2: 1.1
3.1.50.3: 1.0

3.1.51: List Auto-Scaling Groups

3.1.51.1: 1.2
3.1.51.2: 1.1
3.1.51.3: 1.0

3.1.52: List Default Configs

3.1.52.1: 1.2
3.1.52.2: 1.1
3.1.52.3: 1.0

3.1.53: List Image members

3.1.53.1: 1.2
3.1.53.2: 1.1
3.1.53.3: 1.0

3.1.54: List Images

3.1.54.1: 1.2
3.1.54.2: 1.1
3.1.54.3: 1.0

3.1.55: List Keypairs

3.1.55.1: 1.2
3.1.55.2: 1.1
3.1.55.3: 1.0

3.1.56: List Launch Configurations

3.1.56.1: 1.2
3.1.56.2: 1.1
3.1.56.3: 1.0

3.1.57: List pending Images

3.1.57.1: 1.2
3.1.57.2: 1.1
3.1.57.3: 1.0

3.1.58: List Server Groups

3.1.58.1: 1.2
3.1.58.2: 1.1
3.1.58.3: 1.0

3.1.59: List Server Interfaces

3.1.59.1: 1.2
3.1.59.2: 1.1
3.1.59.3: 1.0

3.1.60: List Server Ips

3.1.60.1: 1.2
3.1.60.2: 1.1
3.1.60.3: 1.0

3.1.61: List Server Types

3.1.61.1: 1.2
3.1.61.2: 1.1
3.1.61.3: 1.0

3.1.62: List Server Volumes

3.1.62.1: 1.2
3.1.62.2: 1.1
3.1.62.3: 1.0

3.1.63: List snapshots

3.1.63.1: 1.2
3.1.63.2: 1.1
3.1.63.3: 1.0

3.1.64: List Virtual Server Security Group

3.1.64.1: 1.2
3.1.64.2: 1.1
3.1.64.3: 1.0

3.1.65: List Virtual Servers

3.1.65.1: 1.2
3.1.65.2: 1.1
3.1.65.3: 1.0

3.1.66: List volume transfers

3.1.66.1: 1.2
3.1.66.2: 1.1
3.1.66.3: 1.0

3.1.67: List volume types

3.1.67.1: 1.2
3.1.67.2: 1.1
3.1.67.3: 1.0

3.1.68: List volumes

3.1.68.1: 1.2
3.1.68.2: 1.1
3.1.68.3: 1.0

3.1.69: Lock Virtual Server

3.1.69.1: 1.2
3.1.69.2: 1.1
3.1.69.3: 1.0

3.1.70: Reboot Virtual Server

3.1.70.1: 1.2
3.1.70.2: 1.1
3.1.70.3: 1.0

3.1.71: Rebuild Virtual Server

3.1.71.1: 1.2
3.1.71.2: 1.1
3.1.71.3: 1.0

3.1.72: Revert Volume to snapshot

3.1.72.1: 1.2
3.1.72.2: 1.1
3.1.72.3: 1.0

3.1.73: Set Volume Qos

3.1.73.1: 1.2

3.1.74: Show a snapshot’s details

3.1.74.1: 1.2
3.1.74.2: 1.1
3.1.74.3: 1.0

3.1.75: Show Auto-Scaling Group

3.1.75.1: 1.2
3.1.75.2: 1.1
3.1.75.3: 1.0

3.1.76: Show Auto-Scaling Group Notification

3.1.76.1: 1.2
3.1.76.2: 1.1
3.1.76.3: 1.0

3.1.77: Show Auto-Scaling Group Policy

3.1.77.1: 1.2
3.1.77.2: 1.1
3.1.77.3: 1.0

3.1.78: Show Auto-Scaling Group Schedule

3.1.78.1: 1.2
3.1.78.2: 1.1
3.1.78.3: 1.0

3.1.79: Show default Volume type’s details

3.1.79.1: 1.2
3.1.79.2: 1.1
3.1.79.3: 1.0

3.1.80: Show Image

3.1.80.1: 1.2
3.1.80.2: 1.1
3.1.80.3: 1.0

3.1.81: Show Image member

3.1.81.1: 1.2
3.1.81.2: 1.1
3.1.81.3: 1.0

3.1.82: Show Keypair

3.1.82.1: 1.2
3.1.82.2: 1.1
3.1.82.3: 1.0

3.1.83: Show Launch Configuration

3.1.83.1: 1.2
3.1.83.2: 1.1
3.1.83.3: 1.0

3.1.84: Show Server Group

3.1.84.1: 1.2
3.1.84.2: 1.1
3.1.84.3: 1.0

3.1.85: Show Server Interface

3.1.85.1: 1.2
3.1.85.2: 1.1
3.1.85.3: 1.0

3.1.86: Show Server Ip

3.1.86.1: 1.2
3.1.86.2: 1.1
3.1.86.3: 1.0

3.1.87: Show Server Quota Set

3.1.87.1: 1.2
3.1.87.2: 1.1
3.1.87.3: 1.0

3.1.88: Show Server Type

3.1.88.1: 1.2
3.1.88.2: 1.1
3.1.88.3: 1.0

3.1.89: Show Server Volume

3.1.89.1: 1.2
3.1.89.2: 1.1
3.1.89.3: 1.0

3.1.90: Show Virtual Server

3.1.90.1: 1.2
3.1.90.2: 1.1
3.1.90.3: 1.0

3.1.91: Show Virtual Server Console Log

3.1.91.1: 1.2
3.1.91.2: 1.1
3.1.91.3: 1.0

3.1.92: Show Virtual Server Password

3.1.92.1: 1.2
3.1.92.2: 1.1
3.1.92.3: 1.0

3.1.93: Show Volume Quota Set

3.1.93.1: 1.2
3.1.93.2: 1.1
3.1.93.3: 1.0

3.1.94: Show volume transfer detail

3.1.94.1: 1.2
3.1.94.2: 1.1
3.1.94.3: 1.0

3.1.95: Show Volume type’s details

3.1.95.1: 1.2
3.1.95.2: 1.1
3.1.95.3: 1.0

3.1.96: Show Volume's details

3.1.96.1: 1.2
3.1.96.2: 1.1
3.1.96.3: 1.0

3.1.97: Start Virtual Server

3.1.97.1: 1.2
3.1.97.2: 1.1
3.1.97.3: 1.0

3.1.98: Stop Virtual Server

3.1.98.1: 1.2
3.1.98.2: 1.1
3.1.98.3: 1.0

3.1.99: Unlock Virtual Server

3.1.99.1: 1.2
3.1.99.2: 1.1
3.1.99.3: 1.0

3.1.100: Update a snapshot

3.1.100.1: 1.2
3.1.100.2: 1.1
3.1.100.3: 1.0

3.1.101: Update Auto-Scaling Group

3.1.101.1: 1.2
3.1.101.2: 1.1
3.1.101.3: 1.0

3.1.102: Update Auto-Scaling Group LB Server Groups

3.1.102.1: 1.2
3.1.102.2: 1.1
3.1.102.3: 1.0

3.1.103: Update Auto-Scaling Group Notification

3.1.103.1: 1.2
3.1.103.2: 1.1
3.1.103.3: 1.0

3.1.104: Update Auto-Scaling Group Policy

3.1.104.1: 1.2
3.1.104.2: 1.1
3.1.104.3: 1.0

3.1.105: Update Auto-Scaling Group Schedule

3.1.105.1: 1.2
3.1.105.2: 1.1
3.1.105.3: 1.0

3.1.106: Update Auto-Scaling Group server count

3.1.106.1: 1.2
3.1.106.2: 1.1
3.1.106.3: 1.0

3.1.107: Update Image

3.1.107.1: 1.2
3.1.107.2: 1.1
3.1.107.3: 1.0

3.1.108: Update Image member

3.1.108.1: 1.2
3.1.108.2: 1.1
3.1.108.3: 1.0

3.1.109: Update Server Interface

3.1.109.1: 1.2
3.1.109.2: 1.1
3.1.109.3: 1.0

3.1.110: Update Server Volume

3.1.110.1: 1.2
3.1.110.2: 1.1
3.1.110.3: 1.0

3.1.111: Update Virtual Server

3.1.111.1: 1.2
3.1.111.2: 1.1
3.1.111.3: 1.0

3.1.112: Update Virtual Server type

3.1.112.1: 1.2
3.1.112.2: 1.1
3.1.112.3: 1.0

3.1.113: Update Volume

3.1.113.1: 1.2
3.1.113.2: 1.1
3.1.113.3: 1.0

1 - Bare Metal Server

Overview

Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.

This guide provides a brief description of Bare Metal Server service and how to call CLI.

Version

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Status	Not Before
1.1	CURRENT	-
1.0	DEPRECATED	20251231

1.1 - CLIs

1.1.1 - Assign Baremetal Private NAT IP

1.1.1.1 - 1.1

scpcli baremetal private-nat-ip create
--baremetal_id <value>
--private_nat_ip_id <value>
--private_nat_id <value>

Description

Assign Private NAT IP at Bare Metal Server.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
baremetal_id required	string	Bare Metal Server ID	`20c507a036c447cdb3b19468d8ea62ac`
private_nat_ip_id required	string	Private NAT IP ID	`03cd065d8acc4e47b11a11dc1411323e`
private_nat_id required	string	Private NAT ID	`a4fd0216cd32442a82733bbb8be0e82b`

Responses

Name	Description	Example
nat_id	NAT ID	a4fd0216cd32442a82733bbb8be0e82b
nat_ip	NAT IP	192.170.2.10
nat_ip_id	NAT IP ID	20c507a036c447cdb3b19468d8ea62ac
state	Static NAT state	ACTIVE
static_nat_id	Static NAT ID	a1b97ae4695b40b0866e86a19cb191d3

1.1.2 - Assign Baremetal Public NAT IP

1.1.2.1 - 1.1

scpcli baremetal nat-ip create
--baremetal_id <value>
--public_ip_address_id <value>

Description

Assign Public NAT IP at Bare Metal Server.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
baremetal_id required	string	Bare Metal Server ID	`20c507a036c447cdb3b19468d8ea62ac`
public_ip_address_id required	string	Public IP ID	`20c507a036c447cdb3b19468d8ea62ac`

Responses

Name	Description	Example
baremetal_id	Bare Metal Server ID	20c507a036c447cdb3b19468d8ea62ac

1.1.2.2 - 1.0

scpcli baremetal nat-ip create
--baremetal_id <value>
--public_ip_address_id <value>

Description

Assign Public NAT IP at Bare Metal Server.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
baremetal_id required	string	Bare Metal Server ID	`20c507a036c447cdb3b19468d8ea62ac`
public_ip_address_id required	string	Public IP ID	`20c507a036c447cdb3b19468d8ea62ac`

Responses

Name	Description	Example
baremetal_id	Bare Metal Server ID	20c507a036c447cdb3b19468d8ea62ac

1.1.3 - Attach Baremetal Local Subnet

1.1.3.1 - 1.1

scpcli baremetal local-subnet create
--baremetal_id <value>
--local_subnet_id <value>
[--local_subnet_ip <value>]

Description

Attach Local Subnet for Bare Metal Server.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
baremetal_id required	string	Bare Metal Server ID	`20c507a036c447cdb3b19468d8ea62ac`
local_subnet_id required	string	Local Subnet ID	`ab313c43291e4b678f4bacffe10768ae`
local_subnet_ip optional	string	Policy Local Subnet IP	`192.168.0.1`

1.1.3.2 - 1.0

scpcli baremetal local-subnet create
--baremetal_id <value>
--local_subnet_id <value>
[--local_subnet_ip <value>]

Description

Attach Local Subnet for Bare Metal Server.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
baremetal_id required	string	Bare Metal Server ID	`20c507a036c447cdb3b19468d8ea62ac`
local_subnet_id required	string	Local Subnet ID	`ab313c43291e4b678f4bacffe10768ae`
local_subnet_ip optional	string	Policy Local Subnet IP	`192.168.0.1`

1.1.4 - Create Baremetals

1.1.4.1 - 1.1

scpcli baremetal baremetal create
--vpc_id <value>
--subnet_id <value>
--server_details <value>
--region_id <value>
--os_user_password <value>
--os_user_id <value>
--image_id <value>
[--init_script <value>]
[--lock_enabled <value>]
[--placement_group_name <value>]
[--tags <value>]
[--use_placement_group <value>]

Description

Create Bare Metal Servers.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
vpc_id required	string	VPC ID	`e58348b1bc9148e5af86500fd4ef99ca`
subnet_id required	string	Subnet ID	`ab313c43291e4b678f4bacffe10768ae`
server_details required	array	Detailed settings for each server	'{"bare_metal_local_subnet_id": "ab313c43291e4b678f4bacffe10768ae", "bare_metal_local_subnet_ip_address": "192.168.0.1", "bare_metal_server_name": "bmserver-001", "ip_address": "192.168.0.1", "local_disk_partitions": [{"mount_point": "/mountpoint", "partition_name": "partitionname", "partition_size": 20, "partition_type": "ext4"}], "local_disk_type": "flat", "nat_enabled": true, "public_ip_address_id": "20c507a036c447cdb3b19468d8ea62ac", "server_type_id": "PRODUCT-0iT9dNiLr4lVoYmjlY2Vgg", "use_hyper_threading": true}'
region_id required	string	Region ID	`kr-west1`
os_user_password required	string	OS user password	`password`
os_user_id required	string	OS user ID	`user001`
image_id required	string	Image ID	`IMAGE-7XFMaJpLsapKvskFMjCtmm`
init_script optional	string	Init script	`init script`
lock_enabled optional	boolean	Use Lock	`True`
placement_group_name optional	string	Placement Group Name	`pgtest`
tags optional	array	Tag	`'{"key": "key", "value": "value"}'`
use_placement_group optional	boolean	Use Placement Group	`False`

Responses

Name	Description	Example
account_id	Account ID	f5c8e56a4d9b49a8bd89e14758a32d53
request_id	Request ID	req-002daa83-52d9-41e8-9b0f-d31d35610f65
resource_id	Resource ID	20c507a036c447cdb3b19468d8ea62ac

1.1.4.2 - 1.0

scpcli baremetal baremetal create
--vpc_id <value>
--subnet_id <value>
--server_details <value>
--region_id <value>
--os_user_password <value>
--os_user_id <value>
--image_id <value>
[--init_script <value>]
[--lock_enabled <value>]
[--placement_group_name <value>]
[--tags <value>]
[--use_placement_group <value>]

Description

Create Bare Metal 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

Name	Type	Description	Example
vpc_id required	string	VPC ID	`e58348b1bc9148e5af86500fd4ef99ca`
subnet_id required	string	Subnet ID	`ab313c43291e4b678f4bacffe10768ae`
server_details required	array	Detailed settings for each server	'{"bare_metal_local_subnet_id": "ab313c43291e4b678f4bacffe10768ae", "bare_metal_local_subnet_ip_address": "192.168.0.1", "bare_metal_server_name": "bmserver-001", "ip_address": "192.168.0.1", "local_disk_partitions": [{"mount_point": "/mountpoint", "partition_name": "partitionname", "partition_size": 20, "partition_type": "ext4"}], "local_disk_type": "flat", "nat_enabled": true, "public_ip_address_id": "20c507a036c447cdb3b19468d8ea62ac", "server_type_id": "PRODUCT-0iT9dNiLr4lVoYmjlY2Vgg", "use_hyper_threading": true}'
region_id required	string	Region ID	`kr-west1`
os_user_password required	string	OS user password	`password`
os_user_id required	string	OS user ID	`user001`
image_id required	string	Image ID	`IMAGE-7XFMaJpLsapKvskFMjCtmm`
init_script optional	string	Init script	`init script`
lock_enabled optional	boolean	Use Lock	`True`
placement_group_name optional	string	Placement Group Name	`pgtest`
tags optional	array	Tag	`'{"key": "key", "value": "value"}'`
use_placement_group optional	boolean	Use Placement Group	`False`

Responses

Name	Description	Example
account_id	Account ID	f5c8e56a4d9b49a8bd89e14758a32d53
request_id	Request ID	req-002daa83-52d9-41e8-9b0f-d31d35610f65
resource_id	Resource ID	20c507a036c447cdb3b19468d8ea62ac

1.1.5 - Delete Baremetal Private NAT IP

1.1.5.1 - 1.1

scpcli baremetal private-nat-ip delete
--baremetal_id <value>

Description

Delete Private NAT IP Bare Metal Server.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
baremetal_id required	string	Bare Metal Server ID	`20c507a036c447cdb3b19468d8ea62ac`

1.1.6 - Delete Baremetal Public NAT IP

1.1.6.1 - 1.1

scpcli baremetal nat-ip delete
--baremetal_id <value>

Description

Delete Public NAT IP Bare Metal Server.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
baremetal_id required	string	Bare Metal Server ID	`20c507a036c447cdb3b19468d8ea62ac`

1.1.6.2 - 1.0

scpcli baremetal nat-ip delete
--baremetal_id <value>

Description

Delete Public NAT IP Bare Metal Server.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
baremetal_id required	string	Bare Metal Server ID	`20c507a036c447cdb3b19468d8ea62ac`

1.1.7 - Delete Baremetals

1.1.7.1 - 1.1

scpcli baremetal baremetal delete
--baremetal_id_list <value>

Description

Delete Bare Metal Servers.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
baremetal_id_list required	array	Bare Metal Server IDs	`20c507a036c447cdb3b19468d8ea62ac`

1.1.7.2 - 1.0

scpcli baremetal baremetal delete
--baremetal_id_list <value>

Description

Delete Bare Metal 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

Name	Type	Description	Example
baremetal_id_list required	array	Bare Metal Server IDs	`20c507a036c447cdb3b19468d8ea62ac`

1.1.8 - Detach Baremetal Local Subnet

1.1.8.1 - 1.1

scpcli baremetal local-subnet delete
--baremetal_id <value>
--local_subnet_ip <value>
--local_subnet_id <value>

Description

Detach Local Subnet for Bare Metal Server.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
baremetal_id required	string	Bare Metal Server ID	`20c507a036c447cdb3b19468d8ea62ac`
local_subnet_ip required	string	Policy Local Subnet IP	`192.168.0.1`
local_subnet_id required	string	Local Subnet ID	`ab313c43291e4b678f4bacffe10768ae`

1.1.8.2 - 1.0

scpcli baremetal local-subnet delete
--baremetal_id <value>
--local_subnet_ip <value>
--local_subnet_id <value>

Description

Detach Local Subnet for Bare Metal Server.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
baremetal_id required	string	Bare Metal Server ID	`20c507a036c447cdb3b19468d8ea62ac`
local_subnet_ip required	string	Policy Local Subnet IP	`192.168.0.1`
local_subnet_id required	string	Local Subnet ID	`ab313c43291e4b678f4bacffe10768ae`

1.1.9 - List Baremetal Images

1.1.9.1 - 1.1

scpcli baremetal image list
--region_id <value>

Description

List Bare Metal Server Images.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
region_id required	string	Region ID	`kr-west1`

Responses

Name	Description	Example
id	Image ID	IMAGE-7XFMaJpLsapKvskFMjCtmm
created_at	Created at	2024-07-11 08:56:59
name	Image name	RHEL 8.8 for BM
os_distro	OS type	RHEL
scp_image_type	Image Type	STANDARD
scp_os_version	OS version	8.7

1.1.9.2 - 1.0

scpcli baremetal image list
--region_id <value>

Description

List Bare Metal Server 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

Name	Type	Description	Example
region_id required	string	Region ID	`kr-west1`

Responses

Name	Description	Example
id	Image ID	IMAGE-7XFMaJpLsapKvskFMjCtmm
created_at	Created at	2024-07-11 08:56:59
name	Image name	RHEL 8.8 for BM
os_distro	OS type	RHEL
scp_image_type	Image Type	STANDARD
scp_os_version	OS version	8.7

1.1.10 - List Baremetal Products

1.1.10.1 - 1.1

scpcli baremetal product list
[--image_id <value>]

Description

List Bare Metal Server products.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
image_id optional	string	Image ID	`IMAGE-7XFMaJpLsapKvskFMjCtmm`

Responses

Name	Description	Example
id	ID	PRODUCT-0iT9dNiLr4lVoYmjlY2Vgg
compute_class_type_name	Compute class type name	StandardMetal-2
compute_class_type_value	Compute class type value	s2_metal
cpu_name	CPU name	cpu 16 vCore
cpu_unit	CPU unit	vCPU
cpu_value	CPU value	64
created_at	Created At	2024-05-17T00:23:17Z
description	Description	vCPU 16 │ Memory 128G │ Disk 480G
disk_unit	Disk unit	GB
disk_value	Disk value	480
memory_name	Memory name	server memory 128GB
memory_unit	Memory unit	GB
memory_value	Memory value	128
modified_at	Modified At	2024-05-17T00:23:17Z
name	Name	s2v16m128_metal
name_with_generation	Name with generation	s2v16m128_metal
os_disk_gb	OS disk value	480
state	State	AVAILABLE
type	Type	SCALE

1.1.10.2 - 1.0

scpcli baremetal product list
[--image_id <value>]

Description

List Bare Metal Server products.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
image_id optional	string	Image ID	`IMAGE-7XFMaJpLsapKvskFMjCtmm`

Responses

Name	Description	Example
id	ID	PRODUCT-0iT9dNiLr4lVoYmjlY2Vgg
attri_name	Attribute name	attri name
attri_value	Attribute value	attri value
compute_class_type_name	Compute class type name	StandardMetal-2
compute_class_type_unit	Compute class type unit	compute_class_type_unit
compute_class_type_value	Compute class type value	s2_metal
cpu_generation	CPU generation	cpu generation
cpu_name	CPU name	cpu 16 vCore
cpu_unit	CPU unit	vCPU
cpu_value	CPU value	64
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Description	vCPU 16 │ Memory 128G │ Disk 480G
disk_name	Disk name	disk_name
disk_unit	Disk unit	GB
disk_value	Disk value	480
infiniband_name	InfiniBand name	infiniband_name
infiniband_unit	InfiniBand unit	infiniband_unit
infiniband_value	Infiniband value	infiniband_value
memory_name	Memory name	server memory 128GB
memory_unit	Memory unit	GB
memory_value	Memory value	128
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Name	s2v16m128_metal
name_with_generation	Name with generation	s2v16m128_metal
socket_name	Socket name	socket_name
socket_unit	Socket unit	socket_unit
socket_value	Socket value	socket_value
state	State	AVAILABLE
type	Type	SCALE

1.1.11 - List Baremetals

1.1.11.1 - 1.1

scpcli baremetal baremetal list
[--size <value>]
[--page <value>]
[--sort <value>]
[--server_name <value>]
[--state <value>]
[--ip <value>]
[--vpc_id <value>]

Description

Get Bare Metal Servers list.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
server_name optional	string	Bare Metal Server name	`bmserver-001`
state optional	string	Bare Metal Server state	`RUNNING`
ip optional	string	Bare Metal Server IP address	`192.168.0.1`
vpc_id optional	string	VPC ID	`e58348b1bc9148e5af86500fd4ef99ca`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
image_id	Image ID	IMAGE-7XFMaJpLsapKvskFMjCtmm
image_version	Image version	RHEL 8.7 for BM
lock_enabled	Use Lock	True
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
network_id	Subnet ID	ab313c43291e4b678f4bacffe10768ae
os_type	OS type	WINDOWS
placement_group_name	Placement Group Name	pgtest
policy_ip	Policy IP	192.168.0.1
product_type_id	Bare Metal Server scale ID	PRODUCT-0iT9dNiLr4lVoYmjlY2Vgg
region_id	Region ID	kr-west1
server_name	Bare Metal Server name	bmserver-001
server_type	Bare Metal Server scale type	s1v8m32_metal
state	Bare Metal Server state	RUNNING
vpc_id	VPC ID	e58348b1bc9148e5af86500fd4ef99ca

1.1.11.2 - 1.0

scpcli baremetal baremetal list
[--size <value>]
[--page <value>]
[--sort <value>]
[--server_name <value>]
[--state <value>]
[--ip <value>]
[--vpc_id <value>]

Description

Get Bare Metal Servers 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

Name	Type	Description	Example
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
server_name optional	string	Bare Metal Server name	`bmserver-001`
state optional	string	Bare Metal Server state	`RUNNING`
ip optional	string	Bare Metal Server IP address	`192.168.0.1`
vpc_id optional	string	VPC ID	`e58348b1bc9148e5af86500fd4ef99ca`

Responses

Name	Description	Example
id	Bare Metal Server ID	20c507a036c447cdb3b19468d8ea62ac
account_id	Account ID	f5c8e56a4d9b49a8bd89e14758a32d53
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created by	ef716e80-1fac-4faa-892d-0132fc7f5583
hyper_threading_use	Use Hyper Threading	True
image_id	Image ID	IMAGE-7XFMaJpLsapKvskFMjCtmm
image_version	Image version	RHEL 8.7 for BM
init_script	Init script	init script
local_subnet_info	Local Subnet info
lock_enabled	Use Lock	True
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified by	ef716e80-1fac-4faa-892d-0132fc7f5583
network_id	Subnet ID	ab313c43291e4b678f4bacffe10768ae
os_type	OS type	WINDOWS
placement_group_name	Placement Group Name	pgtest
policy_ip	Policy IP	192.168.0.1
policy_nat	Public NAT IP	192.168.0.1
policy_use_nat	Use Public NAT	True
product_type_id	Bare Metal Server scale ID	PRODUCT-0iT9dNiLr4lVoYmjlY2Vgg
public_nat_status	Public NAT status	ACTIVE
region_id	Region ID	kr-west1
root_account	Root Account	rootaccount
server_name	Bare Metal Server name	bmserver-001
server_type	Bare Metal Server scale type	s1v8m32_metal
state	Bare Metal Server state	RUNNING
time_zone	Time Zone	Asia/Seoul
use_local_subnet	Use Local Subnet	True
vpc_id	VPC ID	e58348b1bc9148e5af86500fd4ef99ca

1.1.12 - Lock Baremetal

1.1.12.1 - 1.1

scpcli baremetal baremetal lock
--baremetal_id <value>

Description

Lock Bare Metal Server.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
baremetal_id required	string	Bare Metal Server ID	`20c507a036c447cdb3b19468d8ea62ac`

1.1.12.2 - 1.0

scpcli baremetal baremetal lock
--baremetal_id <value>

Description

Lock Bare Metal Server.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
baremetal_id required	string	Bare Metal Server ID	`20c507a036c447cdb3b19468d8ea62ac`

1.1.13 - Show Baremetal

1.1.13.1 - 1.1

scpcli baremetal baremetal show
--baremetal_id <value>

Description

Show Bare Metal Server.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
baremetal_id required	string	Bare Metal Server ID	`20c507a036c447cdb3b19468d8ea62ac`

Responses

Name	Description	Example
interface_name	Interface Name	ens8f1,bond_serv.2
local_subnet_id	Local Subnet ID	ab313c43291e4b678f4bacffe10768ae
policy_local_subnet_ip	Policy Local Subnet IP	192.168.0.1
state	LocalSubnet IP state	CREATING
vlan_id	Vlan Id	500
vni_role_name	VNI Role Name	mgmtJ4dzQBo

1.1.13.2 - 1.0

scpcli baremetal baremetal show
--baremetal_id <value>

Description

Show Bare Metal Server.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
baremetal_id required	string	Bare Metal Server ID	`20c507a036c447cdb3b19468d8ea62ac`

Responses

Name	Description	Example
interface_name	Interface Name	ens8f1,bond_serv.2
local_subnet_id	Local Subnet ID	ab313c43291e4b678f4bacffe10768ae
policy_local_subnet_ip	Policy Local Subnet IP	192.168.0.1
state	LocalSubnet IP state	CREATING
vlan_id	Vlan Id	500
vni_role_name	VNI Role Name	mgmtJ4dzQBo

1.1.14 - Start Baremetals

1.1.14.1 - 1.1

scpcli baremetal baremetal start
--bare_metal_server_ids <value>

Description

Start Bare Metal Servers.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
bare_metal_server_ids required	array	Bare Metal Server IDs	`20c507a036c447cdb3b19468d8ea62ac`

Responses

Name	Description	Example
account_id	Account ID	f5c8e56a4d9b49a8bd89e14758a32d53
request_id	Request ID	req-002daa83-52d9-41e8-9b0f-d31d35610f65
resource_id	Resource ID	20c507a036c447cdb3b19468d8ea62ac

1.1.14.2 - 1.0

scpcli baremetal baremetal start
--bare_metal_server_ids <value>

Description

Start Bare Metal 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

Name	Type	Description	Example
bare_metal_server_ids required	array	Bare Metal Server IDs	`20c507a036c447cdb3b19468d8ea62ac`

Responses

Name	Description	Example
account_id	Account ID	f5c8e56a4d9b49a8bd89e14758a32d53
request_id	Request ID	req-002daa83-52d9-41e8-9b0f-d31d35610f65
resource_id	Resource ID	20c507a036c447cdb3b19468d8ea62ac

1.1.15 - Stop Baremetals

1.1.15.1 - 1.1

scpcli baremetal baremetal stop
--bare_metal_server_ids <value>

Description

Stop Bare Metal Servers.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
bare_metal_server_ids required	array	Bare Metal Server IDs	`20c507a036c447cdb3b19468d8ea62ac`

Responses

Name	Description	Example
account_id	Account ID	f5c8e56a4d9b49a8bd89e14758a32d53
request_id	Request ID	req-002daa83-52d9-41e8-9b0f-d31d35610f65
resource_id	Resource ID	20c507a036c447cdb3b19468d8ea62ac

1.1.15.2 - 1.0

scpcli baremetal baremetal stop
--bare_metal_server_ids <value>

Description

Stop Bare Metal 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

Name	Type	Description	Example
bare_metal_server_ids required	array	Bare Metal Server IDs	`20c507a036c447cdb3b19468d8ea62ac`

Responses

Name	Description	Example
account_id	Account ID	f5c8e56a4d9b49a8bd89e14758a32d53
request_id	Request ID	req-002daa83-52d9-41e8-9b0f-d31d35610f65
resource_id	Resource ID	20c507a036c447cdb3b19468d8ea62ac

1.1.16 - Unlock Baremetal

1.1.16.1 - 1.1

scpcli baremetal baremetal unlock
--baremetal_id <value>

Description

Unlock Bare Metal Server.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
baremetal_id required	string	Bare Metal Server ID	`20c507a036c447cdb3b19468d8ea62ac`

1.1.16.2 - 1.0

scpcli baremetal baremetal unlock
--baremetal_id <value>

Description

Unlock Bare Metal Server.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
baremetal_id required	string	Bare Metal Server ID	`20c507a036c447cdb3b19468d8ea62ac`

2 - Cloud Functions

Overview

Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.

This guide provides a brief description of Cloud Function service and how to call CLI.

Version

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Status	Not Before
1.3	CURRENT	-
1.2	DEPRECATED	20260630
1.1	DEPRECATED	20260430
1.0	DEPRECATED	20251231

2.1 - CLIs

2.1.1 - Approve PrivateLink Endpoint

2.1.1.1 - 1.3

scpcli scf privatelink-endpoint approve
--endpoint_id <value>
--cloud_function_id <value>
--type <value>

Description

approve PrivateLink Endpoint

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
endpoint_id required	string	Endpoint Id	`8c9f6c1c928a45b4bbd1e4da5531d656`
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
type required	string	Type	`APPROVE`

2.1.1.2 - 1.2

scpcli scf privatelink-endpoint approve
--endpoint_id <value>
--cloud_function_id <value>
--type <value>

Description

approve PrivateLink Endpoint

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
endpoint_id required	string	Endpoint Id	`8c9f6c1c928a45b4bbd1e4da5531d656`
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
type required	string	Type	`APPROVE`

2.1.2 - Check Function Name Duplication

2.1.2.1 - 1.3

scpcli scf cloud-function duplication show
--name <value>

Description

check name duplication

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
name required	string	Name	`sample-function-name`

Responses

Name	Description	Example
result	Result	True

2.1.2.2 - 1.2

scpcli scf cloud-function duplication show
--name <value>

Description

check name duplication

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
name required	string	Name	`sample-function-name`

Responses

Name	Description	Example
result	Result	True

2.1.2.3 - 1.1

scpcli scf cloud-function duplication show
--name <value>

Description

check name duplication

State ACTIVE (DEPRECATED)

Deprecated 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	20260430

Parameters

Name	Type	Description	Example
name required	string	Name	`sample-function-name`

Responses

Name	Description	Example
result	Result	True

2.1.2.4 - 1.0

scpcli scf cloud-function duplication show
--name <value>

Description

check name duplication

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
name required	string	Name	`sample-function-name`

Responses

Name	Description	Example
result	Result	True

2.1.3 - Connect PrivateLink Endpoint

2.1.3.1 - 1.3

scpcli scf privatelink-endpoint connect
--endpoint_id <value>
--cloud_function_id <value>
--type <value>

Description

connect PrivateLink Endpoint

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
endpoint_id required	string	Endpoint Id	`8c9f6c1c928a45b4bbd1e4da5531d656`
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
type required	string	Type	`RECONNECT`

2.1.3.2 - 1.2

scpcli scf privatelink-endpoint connect
--endpoint_id <value>
--cloud_function_id <value>
--type <value>

Description

connect PrivateLink Endpoint

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
endpoint_id required	string	Endpoint Id	`8c9f6c1c928a45b4bbd1e4da5531d656`
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
type required	string	Type	`RECONNECT`

2.1.4 - Create Cloud Function

2.1.4.1 - 1.3

scpcli scf cloud-function create
--runtime <value>
--name <value>
--content <value>
[--tags <value>]

Description

create a cloud_function

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
runtime required	string	Runtime	`Node.js:20`
name required	string	Name	`sample-function-name`
content required	string	Code content	`sample`
tags optional	array	Tag List	`'{"key": "", "value": ""}'`

Responses

Name	Description	Example
id	Cloud Functions ID	8c9f6c1c928a45b4bbd1e4da5531d656
message	Description	Description
state	Cloud function state	READY

2.1.4.2 - 1.2

scpcli scf cloud-function create
--runtime <value>
--name <value>
--content <value>
[--tags <value>]

Description

create a cloud_function

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
runtime required	string	Runtime	`Node.js:20`
name required	string	Name	`sample-function-name`
content required	string	Code content	`sample`
tags optional	array	Tag List	`'{"key": "", "value": ""}'`

Responses

Name	Description	Example
id	Cloud Functions ID	8c9f6c1c928a45b4bbd1e4da5531d656
message	Description	Description
state	Cloud function state	READY

2.1.4.3 - 1.1

scpcli scf cloud-function create
--runtime <value>
--name <value>
--content <value>
[--tags <value>]

Description

create a cloud_function

State ACTIVE (DEPRECATED)

Deprecated 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	20260430

Parameters

Name	Type	Description	Example
runtime required	string	Runtime	`Node.js:20`
name required	string	Name	`sample-function-name`
content required	string	Code content	`sample`
tags optional	array	Tag List	`'{"key": "", "value": ""}'`

Responses

Name	Description	Example
id	Cloud Functions ID	8c9f6c1c928a45b4bbd1e4da5531d656
message	Description	Description
state	Cloud function state	READY

2.1.4.4 - 1.0

scpcli scf cloud-function create
--runtime <value>
--name <value>
--content <value>
[--tags <value>]

Description

create a cloud_function

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
runtime required	string	Runtime	`Node.js:20`
name required	string	Name	`sample-function-name`
content required	string	Code content	`sample`
tags optional	array	Tag List	`'{"key": "", "value": ""}'`

Responses

Name	Description	Example
id	Cloud Functions ID	8c9f6c1c928a45b4bbd1e4da5531d656
message	Description	Description
state	Cloud function state	READY

2.1.5 - Create Cloud Function Apigateway Trigger

2.1.5.1 - 1.3

scpcli scf cloud-function apigateway trigger create
--cloud_function_id <value>
--apigateway_stage_name <value>
--apigateway_api_id <value>

Description

create cloud-function apigateway trigger

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
apigateway_stage_name required	string	Apigateway Stage Name	`sample`
apigateway_api_id required	string	Apigateway API ID	`31e749b7b260868f441e862b`

Responses

Name	Description	Example
schedule	Schedule	* * * * 0
timezone	Timezone	Asia/Tokyo
trigger_id	Trigger ID	1
trigger_name	Trigger name	8c9f6c1c928a45b4bbd1e4da5531d656
trigger_target_account_id	Trigger target account ID	617b3d0e90c24a5fa1f65a3824861354
trigger_target_srn	Trigger target SRN	srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe
trigger_target_uuid	Trigger target UUID	8c9f6c1c928a45b4bbd1e4da5531d656
trigger_type	Trigger type	apigateway

2.1.5.2 - 1.2

scpcli scf cloud-function apigateway trigger create
--cloud_function_id <value>
--apigateway_stage_name <value>
--apigateway_api_id <value>

Description

create cloud-function apigateway trigger

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
apigateway_stage_name required	string	Apigateway Stage Name	`sample`
apigateway_api_id required	string	Apigateway API ID	`31e749b7b260868f441e862b`

Responses

Name	Description	Example
schedule	Schedule	* * * * 0
timezone	Timezone	Asia/Tokyo
trigger_id	Trigger ID	1
trigger_name	Trigger name	8c9f6c1c928a45b4bbd1e4da5531d656
trigger_target_account_id	Trigger target account ID	617b3d0e90c24a5fa1f65a3824861354
trigger_target_srn	Trigger target SRN	srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe
trigger_target_uuid	Trigger target UUID	8c9f6c1c928a45b4bbd1e4da5531d656
trigger_type	Trigger type	apigateway

2.1.5.3 - 1.1

scpcli scf cloud-function apigateway trigger create
--cloud_function_id <value>
--apigateway_stage_name <value>
--apigateway_api_id <value>

Description

create cloud-function apigateway trigger

State ACTIVE (DEPRECATED)

Deprecated 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	20260430

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
apigateway_stage_name required	string	Apigateway Stage Name	`sample`
apigateway_api_id required	string	Apigateway API ID	`31e749b7b260868f441e862b`

Responses

Name	Description	Example
schedule	Schedule	* * * * 0
timezone	Timezone	Asia/Tokyo
trigger_id	Trigger ID	1
trigger_name	Trigger name	8c9f6c1c928a45b4bbd1e4da5531d656
trigger_target_account_id	Trigger target account ID	617b3d0e90c24a5fa1f65a3824861354
trigger_target_srn	Trigger target SRN	srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe
trigger_target_uuid	Trigger target UUID	8c9f6c1c928a45b4bbd1e4da5531d656
trigger_type	Trigger type	apigateway

2.1.5.4 - 1.0

scpcli scf cloud-function apigateway trigger create
--cloud_function_id <value>
--apigateway_stage_name <value>
--apigateway_api_id <value>

Description

create cloud-function apigateway trigger

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
apigateway_stage_name required	string	Apigateway Stage Name	`sample`
apigateway_api_id required	string	Apigateway API ID	`31e749b7b260868f441e862b`

Responses

Name	Description	Example
schedule	Schedule	* * * * 0
timezone	Timezone	Asia/Tokyo
trigger_id	Trigger ID	1
trigger_name	Trigger name	8c9f6c1c928a45b4bbd1e4da5531d656
trigger_target_account_id	Trigger target account ID	617b3d0e90c24a5fa1f65a3824861354
trigger_target_srn	Trigger target SRN	srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe
trigger_target_uuid	Trigger target UUID	8c9f6c1c928a45b4bbd1e4da5531d656
trigger_type	Trigger type	apigateway

2.1.6 - Create Cloud Function Cronjob Trigger

2.1.6.1 - 1.3

scpcli scf cloud-function cronjob trigger create
--timezone <value>
--schedule <value>
--cloud_function_id <value>

Description

create cloud-function cronjob trigger

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
timezone required	string	Timezone	`Asia/Tokyo`
schedule required	string	Schedule	`* * * * 0`
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`

Responses

Name	Description	Example
schedule	Schedule	* * * * 0
timezone	Timezone	Asia/Tokyo
trigger_id	Trigger ID	1
trigger_name	Trigger name	8c9f6c1c928a45b4bbd1e4da5531d656
trigger_target_account_id	Trigger target account ID	617b3d0e90c24a5fa1f65a3824861354
trigger_target_srn	Trigger target SRN	srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe
trigger_target_uuid	Trigger target UUID	8c9f6c1c928a45b4bbd1e4da5531d656
trigger_type	Trigger type	apigateway

2.1.6.2 - 1.2

scpcli scf cloud-function cronjob trigger create
--timezone <value>
--schedule <value>
--cloud_function_id <value>

Description

create cloud-function cronjob trigger

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
timezone required	string	Timezone	`Asia/Tokyo`
schedule required	string	Schedule	`* * * * 0`
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`

Responses

Name	Description	Example
schedule	Schedule	* * * * 0
timezone	Timezone	Asia/Tokyo
trigger_id	Trigger ID	1
trigger_name	Trigger name	8c9f6c1c928a45b4bbd1e4da5531d656
trigger_target_account_id	Trigger target account ID	617b3d0e90c24a5fa1f65a3824861354
trigger_target_srn	Trigger target SRN	srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe
trigger_target_uuid	Trigger target UUID	8c9f6c1c928a45b4bbd1e4da5531d656
trigger_type	Trigger type	apigateway

2.1.6.3 - 1.1

scpcli scf cloud-function cronjob trigger create
--timezone <value>
--schedule <value>
--cloud_function_id <value>

Description

create cloud-function cronjob trigger

State ACTIVE (DEPRECATED)

Deprecated 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	20260430

Parameters

Name	Type	Description	Example
timezone required	string	Timezone	`Asia/Tokyo`
schedule required	string	Schedule	`* * * * 0`
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`

Responses

Name	Description	Example
schedule	Schedule	* * * * 0
timezone	Timezone	Asia/Tokyo
trigger_id	Trigger ID	1
trigger_name	Trigger name	8c9f6c1c928a45b4bbd1e4da5531d656
trigger_target_account_id	Trigger target account ID	617b3d0e90c24a5fa1f65a3824861354
trigger_target_srn	Trigger target SRN	srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe
trigger_target_uuid	Trigger target UUID	8c9f6c1c928a45b4bbd1e4da5531d656
trigger_type	Trigger type	apigateway

2.1.6.4 - 1.0

scpcli scf cloud-function cronjob trigger create
--timezone <value>
--schedule <value>
--cloud_function_id <value>

Description

create cloud-function cronjob trigger

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
timezone required	string	Timezone	`Asia/Tokyo`
schedule required	string	Schedule	`* * * * 0`
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`

Responses

Name	Description	Example
schedule	Schedule	* * * * 0
timezone	Timezone	Asia/Tokyo
trigger_id	Trigger ID	1
trigger_name	Trigger name	8c9f6c1c928a45b4bbd1e4da5531d656
trigger_target_account_id	Trigger target account ID	617b3d0e90c24a5fa1f65a3824861354
trigger_target_srn	Trigger target SRN	srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe
trigger_target_uuid	Trigger target UUID	8c9f6c1c928a45b4bbd1e4da5531d656
trigger_type	Trigger type	apigateway

2.1.7 - Create PrivateLink Endpoint

2.1.7.1 - 1.3

scpcli scf privatelink-endpoint create
--cloud_function_id <value>
--service_id <value>
--alias <value>

Description

create privateLink endpoint

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
service_id required	string	Service Id	`8c9f6c1c928a45b4bbd1e4da5531d656`
alias required	string	Alias	`sample`

Responses

Name	Description	Example
endpoint	Endpoint

2.1.7.2 - 1.2

scpcli scf privatelink-endpoint create
--cloud_function_id <value>
--service_id <value>
--alias <value>

Description

create privateLink endpoint

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
service_id required	string	Service Id	`8c9f6c1c928a45b4bbd1e4da5531d656`
alias required	string	Alias	`sample`

Responses

Name	Description	Example
endpoint	Endpoint

2.1.8 - Delete Cloud Function

2.1.8.1 - 1.3

scpcli scf cloud-function delete
--cloud_function_id <value>

Description

delete a specific cloud_function

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`

2.1.8.2 - 1.2

scpcli scf cloud-function delete
--cloud_function_id <value>

Description

delete a specific cloud_function

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`

2.1.8.3 - 1.1

scpcli scf cloud-function delete
--cloud_function_id <value>

Description

delete a specific cloud_function

State ACTIVE (DEPRECATED)

Deprecated 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	20260430

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`

2.1.8.4 - 1.0

scpcli scf cloud-function delete
--cloud_function_id <value>

Description

delete a specific cloud_function

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`

2.1.9 - Delete Cloud Function Trigger

2.1.9.1 - 1.3

scpcli scf cloud-function trigger delete
--trigger_id <value>
--trigger_type <value>
--cloud_function_id <value>

Description

delete a specific cloud function trigger

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
trigger_id required	integer	Trigger ID	`1`
trigger_type required	string	Trigger type	`apigateway`
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`

2.1.9.2 - 1.2

scpcli scf cloud-function trigger delete
--trigger_id <value>
--trigger_type <value>
--cloud_function_id <value>

Description

delete a specific cloud function trigger

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
trigger_id required	integer	Trigger ID	`1`
trigger_type required	string	Trigger type	`apigateway`
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`

2.1.9.3 - 1.1

scpcli scf cloud-function trigger delete
--trigger_id <value>
--trigger_type <value>
--cloud_function_id <value>

Description

delete a specific cloud function trigger

State ACTIVE (DEPRECATED)

Deprecated 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	20260430

Parameters

Name	Type	Description	Example
trigger_id required	integer	Trigger ID	`1`
trigger_type required	string	Trigger type	`apigateway`
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`

2.1.9.4 - 1.0

scpcli scf cloud-function trigger delete
--trigger_id <value>
--trigger_type <value>
--cloud_function_id <value>

Description

delete a specific cloud function trigger

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
trigger_id required	integer	Trigger ID	`1`
trigger_type required	string	Trigger type	`apigateway`
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`

2.1.10 - Delete PrivateLink Endpoint

2.1.10.1 - 1.3

scpcli scf privatelink-endpoint delete
--endpoint_id <value>
--cloud_function_id <value>

Description

delete privateLink endpoint

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
endpoint_id required	string	Endpoint Id	`8c9f6c1c928a45b4bbd1e4da5531d656`
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`

2.1.10.2 - 1.2

scpcli scf privatelink-endpoint delete
--endpoint_id <value>
--cloud_function_id <value>

Description

delete privateLink endpoint

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
endpoint_id required	string	Endpoint Id	`8c9f6c1c928a45b4bbd1e4da5531d656`
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`

2.1.11 - Delete Resource Policy

2.1.11.1 - 1.3

scpcli scf resource policy delete
--cloud_function_id <value>

Description

Delete resource policy

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`

2.1.12 - List Cloud Function Triggers

2.1.12.1 - 1.3

scpcli scf cloud-function trigger list
--cloud_function_id <value>
[--sort <value>]
[--page <value>]
[--size <value>]
[--trigger_name <value>]
[--trigger_type <value>]

Description

list cloud-function triggers

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
sort optional	string	sort	`name:asc`
page optional	integer	page	`0`
size optional	integer	size	`20`
trigger_name optional	string	Trigger name	`8c9f6c1c928a45b4bbd1e4da5531d656`
trigger_type optional	string	Trigger type	`apigateway`

Responses

Name	Description	Example
schedule	Schedule	* * * * 0
timezone	Timezone	Asia/Tokyo
trigger_id	Trigger ID	1
trigger_name	Trigger name	8c9f6c1c928a45b4bbd1e4da5531d656
trigger_target_account_id	Trigger target account ID	617b3d0e90c24a5fa1f65a3824861354
trigger_target_srn	Trigger target SRN	srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe
trigger_target_uuid	Trigger target UUID	8c9f6c1c928a45b4bbd1e4da5531d656
trigger_type	Trigger type	apigateway

2.1.12.2 - 1.2

scpcli scf cloud-function trigger list
--cloud_function_id <value>
[--sort <value>]
[--page <value>]
[--size <value>]
[--trigger_name <value>]
[--trigger_type <value>]

Description

list cloud-function triggers

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
sort optional	string	sort	`name:asc`
page optional	integer	page	`0`
size optional	integer	size	`20`
trigger_name optional	string	Trigger name	`8c9f6c1c928a45b4bbd1e4da5531d656`
trigger_type optional	string	Trigger type	`apigateway`

Responses

Name	Description	Example
schedule	Schedule	* * * * 0
timezone	Timezone	Asia/Tokyo
trigger_id	Trigger ID	1
trigger_name	Trigger name	8c9f6c1c928a45b4bbd1e4da5531d656
trigger_target_account_id	Trigger target account ID	617b3d0e90c24a5fa1f65a3824861354
trigger_target_srn	Trigger target SRN	srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe
trigger_target_uuid	Trigger target UUID	8c9f6c1c928a45b4bbd1e4da5531d656
trigger_type	Trigger type	apigateway

2.1.12.3 - 1.1

scpcli scf cloud-function trigger list
--cloud_function_id <value>
[--sort <value>]
[--page <value>]
[--size <value>]
[--trigger_name <value>]
[--trigger_type <value>]

Description

list cloud-function triggers

State ACTIVE (DEPRECATED)

Deprecated 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	20260430

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
sort optional	string	sort	`name:asc`
page optional	integer	page	`0`
size optional	integer	size	`20`
trigger_name optional	string	Trigger name	`8c9f6c1c928a45b4bbd1e4da5531d656`
trigger_type optional	string	Trigger type	`apigateway`

Responses

Name	Description	Example
schedule	Schedule	* * * * 0
timezone	Timezone	Asia/Tokyo
trigger_id	Trigger ID	1
trigger_name	Trigger name	8c9f6c1c928a45b4bbd1e4da5531d656
trigger_target_account_id	Trigger target account ID	617b3d0e90c24a5fa1f65a3824861354
trigger_target_srn	Trigger target SRN	srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe
trigger_target_uuid	Trigger target UUID	8c9f6c1c928a45b4bbd1e4da5531d656
trigger_type	Trigger type	apigateway

2.1.12.4 - 1.0

scpcli scf cloud-function trigger list
--cloud_function_id <value>
[--sort <value>]
[--page <value>]
[--size <value>]
[--trigger_name <value>]
[--trigger_type <value>]

Description

list cloud-function triggers

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
sort optional	string	sort	`name:asc`
page optional	integer	page	`0`
size optional	integer	size	`20`
trigger_name optional	string	Trigger name	`8c9f6c1c928a45b4bbd1e4da5531d656`
trigger_type optional	string	Trigger type	`apigateway`

Responses

Name	Description	Example
schedule	Schedule	* * * * 0
timezone	Timezone	Asia/Tokyo
trigger_id	Trigger ID	1
trigger_name	Trigger name	8c9f6c1c928a45b4bbd1e4da5531d656
trigger_target_account_id	Trigger target account ID	617b3d0e90c24a5fa1f65a3824861354
trigger_target_srn	Trigger target SRN	srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe
trigger_target_uuid	Trigger target UUID	8c9f6c1c928a45b4bbd1e4da5531d656
trigger_type	Trigger type	apigateway

2.1.13 - List Cloud Functions

2.1.13.1 - 1.3

scpcli scf cloud-function list
[--sort <value>]
[--page <value>]
[--size <value>]
[--name <value>]
[--state <value>]
[--runtime <value>]

Description

get cloud_functions list

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
sort optional	string	sort	`name:asc`
page optional	integer	page	`0`
size optional	integer	size	`20`
name optional	string	Name	`sample-function-name`
state optional	array	Cloud function state	`R`
runtime optional	array	Runtime	`N`

Responses

Name	Description	Example
id	Cloud Functions ID	8c9f6c1c928a45b4bbd1e4da5531d656
account_id	Account ID	617b3d0e90c24a5fa1f65a3824861354
created_at	Created At	2025-05-22T06:21:17.580522
function_url	Cloud function Url	https://33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/cloudfunctions-hello
name	Cloud Functions name	sample
runtime	Runtime	Node.js:20
state	Cloud function state	READY
user_id	User ID	617b3d0e90c24a5fa1f65a3824861354

2.1.13.2 - 1.2

scpcli scf cloud-function list
[--sort <value>]
[--page <value>]
[--size <value>]
[--name <value>]
[--state <value>]
[--runtime <value>]

Description

get cloud_functions 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.2	20260630

Parameters

Name	Type	Description	Example
sort optional	string	sort	`name:asc`
page optional	integer	page	`0`
size optional	integer	size	`20`
name optional	string	Name	`sample-function-name`
state optional	array	Cloud function state	`R`
runtime optional	array	Runtime	`N`

Responses

Name	Description	Example
id	Cloud Functions ID	8c9f6c1c928a45b4bbd1e4da5531d656
account_id	Account ID	617b3d0e90c24a5fa1f65a3824861354
created_at	Created At	2025-05-22T06:21:17.580522
function_url	Cloud function Url	https://33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/cloudfunctions-hello
name	Cloud Functions name	sample
runtime	Runtime	Node.js:20
state	Cloud function state	READY
user_id	User ID	617b3d0e90c24a5fa1f65a3824861354

2.1.13.3 - 1.1

scpcli scf cloud-function list
[--sort <value>]
[--page <value>]
[--size <value>]
[--name <value>]
[--state <value>]
[--runtime <value>]

Description

get cloud_functions 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	20260430

Parameters

Name	Type	Description	Example
sort optional	string	sort	`name:asc`
page optional	integer	page	`0`
size optional	integer	size	`20`
name optional	string	Name	`sample-function-name`
state optional	array	Cloud function state	`R`
runtime optional	array	Runtime	`N`

Responses

Name	Description	Example
id	Cloud Functions ID	8c9f6c1c928a45b4bbd1e4da5531d656
account_id	Account ID	617b3d0e90c24a5fa1f65a3824861354
created_at	Created At	2025-05-22T06:21:17.580522
function_url	Cloud function Url	https://33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/cloudfunctions-hello
name	Cloud Functions name	sample
runtime	Runtime	Node.js:20
state	Cloud function state	READY
user_id	User ID	617b3d0e90c24a5fa1f65a3824861354

2.1.13.4 - 1.0

scpcli scf cloud-function list
[--sort <value>]
[--page <value>]
[--size <value>]
[--name <value>]
[--state <value>]
[--runtime <value>]

Description

get cloud_functions 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

Name	Type	Description	Example
sort optional	string	sort	`name:asc`
page optional	integer	page	`0`
size optional	integer	size	`20`
name optional	string	Name	`sample-function-name`
state optional	array	Cloud function state	`R`
runtime optional	array	Runtime	`N`

Responses

Name	Description	Example
id	Cloud Functions ID	8c9f6c1c928a45b4bbd1e4da5531d656
account_id	Account ID	617b3d0e90c24a5fa1f65a3824861354
created_at	Created At	2025-05-22T06:21:17.580522
function_url	Cloud function Url	https://33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/cloudfunctions-hello
name	Cloud Functions name	sample
runtime	Runtime	Node.js:20
state	Cloud function state	READY
user_id	User ID	617b3d0e90c24a5fa1f65a3824861354

2.1.14 - List Environment Variables

2.1.14.1 - 1.3

scpcli scf cloud-function environment variables list
--cloud_function_id <value>
[--sort <value>]

Description

list environment variables

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
sort optional	string	Sort	`key:asc`

Responses

Name	Description	Example
key	Key	sample
value	Value	sample

2.1.15 - List PrivateLink Endpoint

2.1.15.1 - 1.3

scpcli scf privatelink-endpoint list
--cloud_function_id <value>
[--sort <value>]

Description

list privateLink endpoint

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
sort optional	string	Sort	`endpoint_alias:asc`

Responses

Name	Description	Example
endpoint_alias	Alias	sample
endpoint_id	Endpoint Id	8c9f6c1c928a45b4bbd1e4da5531d656
service_id	Service Id	8c9f6c1c928a45b4bbd1e4da5531d656
state	State	Active

2.1.16 - List Runtimes

2.1.16.1 - 1.3

scpcli scf cloud-function runtime list

Description

list runtimes

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Responses

Name	Description	Example
base_image_seq	Base image sequence	3
name	Name	sample
version	Version	1.0.0

2.1.16.2 - 1.2

scpcli scf cloud-function runtime list

Description

list runtimes

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.2	20260630

Responses

Name	Description	Example
base_image_seq	Base image sequence	3
name	Name	sample
version	Version	1.0.0

2.1.16.3 - 1.1

scpcli scf cloud-function runtime list

Description

list runtimes

State ACTIVE (DEPRECATED)

Deprecated 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	20260430

Responses

Name	Description	Example
base_image_seq	Base image sequence	3
name	Name	sample
version	Version	1.0.0

2.1.16.4 - 1.0

scpcli scf cloud-function runtime list

Description

list runtimes

State ACTIVE (DEPRECATED)

Deprecated 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

Name	Description	Example
base_image_seq	Base image sequence	3
name	Name	sample
version	Version	1.0.0

2.1.17 - List Sample Codes

2.1.17.1 - 1.3

scpcli scf cloud-function sample-codes show

Description

List sample codes

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Responses

Name	Description	Example
content	Code content	sample
default	Default	False
description	Description	sample
name	Name	sample
runtime	Runtime	Node.js:20
seq	Sequence	3
version	Version	sample

2.1.17.2 - 1.2

scpcli scf cloud-function sample-codes show

Description

List sample codes

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.2	20260630

Responses

Name	Description	Example
content	Code content	sample
default	Default	False
description	Description	sample
name	Name	sample
runtime	Runtime	Node.js:20
seq	Sequence	3
version	Version	sample

2.1.17.3 - 1.1

scpcli scf cloud-function sample-codes show

Description

List sample codes

State ACTIVE (DEPRECATED)

Deprecated 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	20260430

Responses

Name	Description	Example
content	Code content	sample
default	Default	False
description	Description	sample
name	Name	sample
runtime	Runtime	Node.js:20
seq	Sequence	3
version	Version	sample

2.1.17.4 - 1.0

scpcli scf cloud-function sample-codes show

Description

List sample codes

State ACTIVE (DEPRECATED)

Deprecated 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

Name	Description	Example
content	Code content	sample
default	Default	False
description	Description	sample
name	Name	sample
runtime	Runtime	Node.js:20
seq	Sequence	3
version	Version	sample

2.1.18 - Request PrivateLink Endpoint

2.1.18.1 - 1.3

scpcli scf privatelink-endpoint request
--endpoint_id <value>
--cloud_function_id <value>
--type <value>

Description

request privatelink endpoint

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
endpoint_id required	string	Endpoint Id	`8c9f6c1c928a45b4bbd1e4da5531d656`
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
type required	string	Type	`CANCEL`

2.1.18.2 - 1.2

scpcli scf privatelink-endpoint request
--endpoint_id <value>
--cloud_function_id <value>
--type <value>

Description

request privatelink endpoint

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
endpoint_id required	string	Endpoint Id	`8c9f6c1c928a45b4bbd1e4da5531d656`
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
type required	string	Type	`CANCEL`

2.1.19 - Set Resource Policy

2.1.19.1 - 1.3

scpcli scf resource policy set
--cloud_function_id <value>
--version <value>
--statement <value>

Description

Set resource policy

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
version required	string	Version	`2024-07-01`
statement required	array	Statement	`'{"Action": ["iam:"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": [""], "Sid": "Statement1"}'`

2.1.20 - Show Cloud Function

2.1.20.1 - 1.3

scpcli scf cloud-function show
--cloud_function_id <value>

Description

show a specific cloud_function

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`

Responses

Name	Description	Example
id	Cloud Functions ID	8c9f6c1c928a45b4bbd1e4da5531d656
account_id	Account ID	617b3d0e90c24a5fa1f65a3824861354
function_url	Cloud function Url	https://33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/cloudfunctions-hello
name	Cloud Functions name	sample
runtime	Runtime	Node.js:20
state	Cloud function state	READY
user_id	User ID	617b3d0e90c24a5fa1f65a3824861354

2.1.20.2 - 1.2

scpcli scf cloud-function show
--cloud_function_id <value>

Description

show a specific cloud_function

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`

Responses

Name	Description	Example
id	Cloud Functions ID	8c9f6c1c928a45b4bbd1e4da5531d656
account_id	Account ID	617b3d0e90c24a5fa1f65a3824861354
function_url	Cloud function Url	https://33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/cloudfunctions-hello
name	Cloud Functions name	sample
runtime	Runtime	Node.js:20
state	Cloud function state	READY
user_id	User ID	617b3d0e90c24a5fa1f65a3824861354

2.1.20.3 - 1.1

scpcli scf cloud-function show
--cloud_function_id <value>

Description

show a specific cloud_function

State ACTIVE (DEPRECATED)

Deprecated 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	20260430

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`

Responses

Name	Description	Example
id	Cloud Functions ID	8c9f6c1c928a45b4bbd1e4da5531d656
account_id	Account ID	617b3d0e90c24a5fa1f65a3824861354
function_url	Cloud function Url	https://33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/cloudfunctions-hello
name	Cloud Functions name	sample
runtime	Runtime	Node.js:20
state	Cloud function state	READY
user_id	User ID	617b3d0e90c24a5fa1f65a3824861354

2.1.20.4 - 1.0

scpcli scf cloud-function show
--cloud_function_id <value>

Description

show a specific cloud_function

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`

Responses

Name	Description	Example
id	Cloud Functions ID	8c9f6c1c928a45b4bbd1e4da5531d656
account_id	Account ID	617b3d0e90c24a5fa1f65a3824861354
function_url	Cloud function Url	https://33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/cloudfunctions-hello
name	Cloud Functions name	sample
runtime	Runtime	Node.js:20
state	Cloud function state	READY
user_id	User ID	617b3d0e90c24a5fa1f65a3824861354

2.1.21 - Show Cloud Function Code

2.1.21.1 - 1.3

scpcli scf cloud-function code show
--cloud_function_id <value>

Description

show a specific cloud_function code

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`

Responses

Name	Description	Example
class_name	Class Name	com.example.Handler
code_text	Code Text	ZXhwb3J0cy5oYW5kbGVSZXF1ZXN0ID0gYXN5bmM==
code_type	Code Type	text
file_name	File Name	sample
file_transfer_status	File Transfer Status	sample
file_upload_at	File Upload At	2025-05-17 00:23:17
method_name	Method Name	handleRequest
runtime	Runtime	Node.js:20

2.1.21.2 - 1.2

scpcli scf cloud-function code show
--cloud_function_id <value>

Description

show a specific cloud_function code

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`

Responses

Name	Description	Example
class_name	Class Name	com.example.Handler
code_text	Code Text	ZXhwb3J0cy5oYW5kbGVSZXF1ZXN0ID0gYXN5bmM==
code_type	Code Type	text
file_name	File Name	sample
file_transfer_status	File Transfer Status	sample
file_upload_at	File Upload At	2025-05-17 00:23:17
method_name	Method Name	handleRequest
runtime	Runtime	Node.js:20

2.1.21.3 - 1.1

scpcli scf cloud-function code show
--cloud_function_id <value>

Description

show a specific cloud_function code

State ACTIVE (DEPRECATED)

Deprecated 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	20260430

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`

Responses

Name	Description	Example
class_name	Class Name	com.example.Handler
code_text	Code Text	ZXhwb3J0cy5oYW5kbGVSZXF1ZXN0ID0gYXN5bmM==
code_type	Code Type	text
file_name	File Name	sample
file_transfer_status	File Transfer Status	sample
file_upload_at	File Upload At	2025-05-17 00:23:17
method_name	Method Name	handleRequest
runtime	Runtime	Node.js:20

2.1.21.4 - 1.0

scpcli scf cloud-function code show
--cloud_function_id <value>

Description

show a specific cloud_function code

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`

Responses

Name	Description	Example
class_name	Class Name	com.example.Handler
code_text	Code Text	ZXhwb3J0cy5oYW5kbGVSZXF1ZXN0ID0gYXN5bmM==
code_type	Code Type	text
file_name	File Name	sample
file_transfer_status	File Transfer Status	sample
file_upload_at	File Upload At	2025-05-17 00:23:17
method_name	Method Name	handleRequest
runtime	Runtime	Node.js:20

2.1.22 - Show Cloud Function Configuration

2.1.22.1 - 1.3

scpcli scf cloud-function configuration show
--cloud_function_id <value>

Description

show a specific cloud-function configuration

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`

Responses

Name	Description	Example
endpoint_alias	Alias	sample
endpoint_id	Endpoint Id	8c9f6c1c928a45b4bbd1e4da5531d656
service_id	Service Id	8c9f6c1c928a45b4bbd1e4da5531d656
state	State	Active

2.1.22.2 - 1.2

scpcli scf cloud-function configuration show
--cloud_function_id <value>

Description

show a specific cloud-function 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.2	20260630

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`

Responses

Name	Description	Example
endpoint_alias	Alias	sample
endpoint_id	Endpoint Id	8c9f6c1c928a45b4bbd1e4da5531d656
service_id	Service Id	8c9f6c1c928a45b4bbd1e4da5531d656
state	State	Active

2.1.22.3 - 1.1

scpcli scf cloud-function configuration show
--cloud_function_id <value>

Description

show a specific cloud-function 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	20260430

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`

Responses

Name	Description	Example
key	Key	sample
value	Value	sample

2.1.22.4 - 1.0

scpcli scf cloud-function configuration show
--cloud_function_id <value>

Description

show a specific cloud-function 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

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`

Responses

Name	Description	Example
key	Key	sample
value	Value	sample

2.1.23 - Show Cloud Function Logs

2.1.23.1 - 1.3

scpcli scf cloud-function logs show
--cloud_function_id <value>
[--time <value>]
[--start <value>]
[--end <value>]

Description

show a specific cloud-function logs

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
time optional	integer	Time	`3`
start optional	string	Start	`20250517`
end optional	string	End	`20250517`

Responses

Name	Description	Example
log	Log	[2025-05-12 11:04:12] START RequestId : 04680bac - ad76-4e0a-997e-e35b6275cb67 Version : $LATEST
time	Time	2025-05-17 00:23:17

2.1.23.2 - 1.2

scpcli scf cloud-function logs show
--cloud_function_id <value>
[--time <value>]
[--start <value>]
[--end <value>]

Description

show a specific cloud-function logs

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
time optional	integer	Time	`3`
start optional	string	Start	`20250517`
end optional	string	End	`20250517`

Responses

Name	Description	Example
log	Log	[2025-05-12 11:04:12] START RequestId : 04680bac - ad76-4e0a-997e-e35b6275cb67 Version : $LATEST
time	Time	2025-05-17 00:23:17

2.1.23.3 - 1.1

scpcli scf cloud-function logs show
--cloud_function_id <value>
[--time <value>]
[--start <value>]
[--end <value>]

Description

show a specific cloud-function logs

State ACTIVE (DEPRECATED)

Deprecated 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	20260430

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
time optional	integer	Time	`3`
start optional	string	Start	`20250517`
end optional	string	End	`20250517`

Responses

Name	Description	Example
log	Log	[2025-05-12 11:04:12] START RequestId : 04680bac - ad76-4e0a-997e-e35b6275cb67 Version : $LATEST
time	Time	2025-05-17 00:23:17

2.1.23.4 - 1.0

scpcli scf cloud-function logs show
--cloud_function_id <value>
[--time <value>]
[--start <value>]
[--end <value>]

Description

show a specific cloud-function logs

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
time optional	integer	Time	`3`
start optional	string	Start	`20250517`
end optional	string	End	`20250517`

Responses

Name	Description	Example
log	Log	[2025-05-12 11:04:12] START RequestId : 04680bac - ad76-4e0a-997e-e35b6275cb67 Version : $LATEST
time	Time	2025-05-17 00:23:17

2.1.24 - Show Cloud Function Metrics

2.1.24.1 - 1.3

scpcli scf cloud-function metrics show
--cloud_function_id <value>
[--time <value>]
[--start <value>]
[--end <value>]

Description

show a specific cloud-function metrics

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
time optional	integer	Time	`3`
start optional	string	Start	`20250517`
end optional	string	End	`20250517`

Responses

Name	Description	Example
metric_data	Metric Data	1.0033444816053512
time	Time	16:37

2.1.24.2 - 1.2

scpcli scf cloud-function metrics show
--cloud_function_id <value>
[--time <value>]
[--start <value>]
[--end <value>]

Description

show a specific cloud-function metrics

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
time optional	integer	Time	`3`
start optional	string	Start	`20250517`
end optional	string	End	`20250517`

Responses

Name	Description	Example
metric_data	Metric Data	1.0033444816053512
time	Time	16:37

2.1.24.3 - 1.1

scpcli scf cloud-function metrics show
--cloud_function_id <value>
[--time <value>]
[--start <value>]
[--end <value>]

Description

show a specific cloud-function metrics

State ACTIVE (DEPRECATED)

Deprecated 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	20260430

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
time optional	integer	Time	`3`
start optional	string	Start	`20250517`
end optional	string	End	`20250517`

Responses

Name	Description	Example
metric_data	Metric Data	1.0033444816053512
time	Time	16:37

2.1.24.4 - 1.0

scpcli scf cloud-function metrics show
--cloud_function_id <value>
[--time <value>]
[--start <value>]
[--end <value>]

Description

show a specific cloud-function metrics

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
time optional	integer	Time	`3`
start optional	string	Start	`20250517`
end optional	string	End	`20250517`

Responses

Name	Description	Example
metric_data	Metric Data	1.0033444816053512
time	Time	16:37

2.1.25 - Show Cloud Function Trigger

2.1.25.1 - 1.3

scpcli scf cloud-function trigger show
--trigger_id <value>

Description

show a specific cloud-function trigger

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
trigger_id required	integer	Trigger ID	`1`

Responses

Name	Description	Example
alias	Alias	$LATEST
schedule	Schedule	* * * * 0
timezone	Timezone	Asia/Tokyo
trigger_id	Trigger ID	1
trigger_name	Trigger name	8c9f6c1c928a45b4bbd1e4da5531d656
trigger_sid	Trigger target account ID	617b3d0e90c24a5fa1f65a3824861354
trigger_target_account_id	Trigger target account ID	617b3d0e90c24a5fa1f65a3824861354
trigger_target_srn	Trigger target SRN	srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe
trigger_target_uuid	Trigger target UUID	8c9f6c1c928a45b4bbd1e4da5531d656
trigger_type	Trigger type	apigateway

2.1.25.2 - 1.2

scpcli scf cloud-function trigger show
--trigger_id <value>

Description

show a specific cloud-function trigger

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
trigger_id required	integer	Trigger ID	`1`

Responses

Name	Description	Example
alias	Alias	$LATEST
schedule	Schedule	* * * * 0
timezone	Timezone	Asia/Tokyo
trigger_id	Trigger ID	1
trigger_name	Trigger name	8c9f6c1c928a45b4bbd1e4da5531d656
trigger_sid	Trigger target account ID	617b3d0e90c24a5fa1f65a3824861354
trigger_target_account_id	Trigger target account ID	617b3d0e90c24a5fa1f65a3824861354
trigger_target_srn	Trigger target SRN	srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe
trigger_target_uuid	Trigger target UUID	8c9f6c1c928a45b4bbd1e4da5531d656
trigger_type	Trigger type	apigateway

2.1.25.3 - 1.1

scpcli scf cloud-function trigger show
--trigger_id <value>

Description

show a specific cloud-function trigger

State ACTIVE (DEPRECATED)

Deprecated 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	20260430

Parameters

Name	Type	Description	Example
trigger_id required	integer	Trigger ID	`1`

Responses

Name	Description	Example
alias	Alias	$LATEST
schedule	Schedule	* * * * 0
timezone	Timezone	Asia/Tokyo
trigger_id	Trigger ID	1
trigger_name	Trigger name	8c9f6c1c928a45b4bbd1e4da5531d656
trigger_sid	Trigger target account ID	617b3d0e90c24a5fa1f65a3824861354
trigger_target_account_id	Trigger target account ID	617b3d0e90c24a5fa1f65a3824861354
trigger_target_srn	Trigger target SRN	srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe
trigger_target_uuid	Trigger target UUID	8c9f6c1c928a45b4bbd1e4da5531d656
trigger_type	Trigger type	apigateway

2.1.25.4 - 1.0

scpcli scf cloud-function trigger show
--trigger_id <value>

Description

show a specific cloud-function trigger

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
trigger_id required	integer	Trigger ID	`1`

Responses

Name	Description	Example
alias	Alias	$LATEST
schedule	Schedule	* * * * 0
timezone	Timezone	Asia/Tokyo
trigger_id	Trigger ID	1
trigger_name	Trigger name	8c9f6c1c928a45b4bbd1e4da5531d656
trigger_sid	Trigger target account ID	617b3d0e90c24a5fa1f65a3824861354
trigger_target_account_id	Trigger target account ID	617b3d0e90c24a5fa1f65a3824861354
trigger_target_srn	Trigger target SRN	srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe
trigger_target_uuid	Trigger target UUID	8c9f6c1c928a45b4bbd1e4da5531d656
trigger_type	Trigger type	apigateway

2.1.26 - Show General Config

2.1.26.1 - 1.3

scpcli scf cloud-function config show
--cloud_function_id <value>

Description

show general config

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`

Responses

Name	Description	Example
max_scale	Max Scale	5
memory	Memory	256
min_scale	Min Scale	1
timeout	Timeout	100

2.1.27 - Show PrivateLink Service

2.1.27.1 - 1.3

scpcli scf privatelink-service show
--cloud_function_id <value>
[--sort <value>]

Description

show PrivateLink Service

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
sort optional	string	Sort	`endpoint_id:asc`

Responses

Name	Description	Example
endpoint_alias	Alias	sample
endpoint_id	Endpoint Id	8c9f6c1c928a45b4bbd1e4da5531d656
service_id	Service Id	8c9f6c1c928a45b4bbd1e4da5531d656
state	State	Active

2.1.28 - Show Resource Policy

2.1.28.1 - 1.3

scpcli scf resource policy show
--cloud_function_id <value>

Description

Show resource policy

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`

Responses

Name	Description	Example
policy_document	Policy Document	{‘Statement’: [{‘Action’: [‘scf:InvokeFunction’], ‘Condition’: {‘StringEquals’: {‘scf:CloudFunctionAuthType’: [‘SCP_IAM’]}}, ‘Effect’: ‘Allow’, ‘Principal’: ‘*’, ‘Resource’: [‘srn:e::27bb070b564349f8a31cc60734cc36a5:kr-west1::scf:cloud-function/1a2afa4bfb854a828602c93009cf4447’], ‘Sid’: ‘Statement1’}], ‘Version’: ‘2024-07-01’}

2.1.29 - Show Url Config

2.1.29.1 - 1.3

scpcli scf cloud-function url show
--cloud_function_id <value>

Description

show url config

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`

Responses

Name	Description	Example
allow_ips	Allow Ips
auth_type	Auth Type	NONE
public_endpoint_url	Public Endpoint Url	https://scf.33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/sample-function
public_ip_acl_enabled	Public IP ACL Enabled	True
state	Function URL State	CREATING
url_enabled	URL Enabled	True

2.1.30 - Update Cloud Function Code

2.1.30.1 - 1.3

scpcli scf cloud-function code set
--cloud_function_id <value>
--content <value>

Description

update cloud-function code

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
content required	string	Code content	`print("Hello World")`

2.1.30.2 - 1.2

scpcli scf cloud-function code set
--cloud_function_id <value>
--content <value>

Description

update cloud-function code

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
content required	string	Code content	`print("Hello World")`

2.1.30.3 - 1.1

scpcli scf cloud-function code set
--cloud_function_id <value>
--content <value>

Description

update cloud-function code

State ACTIVE (DEPRECATED)

Deprecated 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	20260430

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
content required	string	Code content	`print("Hello World")`

2.1.30.4 - 1.0

scpcli scf cloud-function code set
--cloud_function_id <value>
--content <value>

Description

update cloud-function code

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
content required	string	Code content	`print("Hello World")`

2.1.31 - Update Cloud Function Code File

2.1.31.1 - 1.3

scpcli scf cloud-function code-file set
--cloud_function_id <value>
--method_name <value>
--class_name <value>
[--obs_url <value>]

Description

update a specific cloud_function code file

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
method_name required	string	Method Name	`handleRequest`
class_name required	string	Class Name	`com.example.Handler`
obs_url optional	string	Object Storage URL	`https://obs.kr-east1.scp-in.com:8443/sample/java-sample-1.0-SNAPSHOT.jar`

2.1.31.2 - 1.2

scpcli scf cloud-function code-file set
--cloud_function_id <value>
--method_name <value>
--class_name <value>
[--obs_url <value>]

Description

update a specific cloud_function code file

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
method_name required	string	Method Name	`handleRequest`
class_name required	string	Class Name	`com.example.Handler`
obs_url optional	string	Object Storage URL	`https://obs.kr-east1.scp-in.com:8443/sample/java-sample-1.0-SNAPSHOT.jar`

2.1.31.3 - 1.1

scpcli scf cloud-function code-file set
--cloud_function_id <value>
--method_name <value>
--class_name <value>
[--obs_url <value>]

Description

update a specific cloud_function code file

State ACTIVE (DEPRECATED)

Deprecated 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	20260430

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
method_name required	string	Method Name	`handleRequest`
class_name required	string	Class Name	`com.example.Handler`
obs_url optional	string	Object Storage URL	`https://obs.kr-east1.scp-in.com:8443/sample/java-sample-1.0-SNAPSHOT.jar`

2.1.32 - Update Cloud Function Config

2.1.32.1 - 1.3

scpcli scf cloud-function config set
--cloud_function_id <value>
--timeout <value>
--min_scale <value>
--memory <value>
--max_scale <value>

Description

update cloud-function config

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
timeout required	integer	Timeout	`100`
min_scale required	integer	Min Scale	`1`
memory required	integer	Memory	`256`
max_scale required	integer	Max Scale	`5`

2.1.32.2 - 1.2

scpcli scf cloud-function config set
--cloud_function_id <value>
--timeout <value>
--min_scale <value>
--memory <value>
--max_scale <value>

Description

update cloud-function config

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
timeout required	integer	Timeout	`100`
min_scale required	integer	Min Scale	`1`
memory required	integer	Memory	`256`
max_scale required	integer	Max Scale	`5`

2.1.32.3 - 1.1

scpcli scf cloud-function config set
--cloud_function_id <value>
--timeout <value>
--min_scale <value>
--memory <value>
--max_scale <value>

Description

update cloud-function config

State ACTIVE (DEPRECATED)

Deprecated 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	20260430

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
timeout required	integer	Timeout	`100`
min_scale required	integer	Min Scale	`1`
memory required	integer	Memory	`256`
max_scale required	integer	Max Scale	`5`

2.1.32.4 - 1.0

scpcli scf cloud-function config set
--cloud_function_id <value>
--timeout <value>
--min_scale <value>
--memory <value>
--max_scale <value>

Description

update cloud-function config

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
timeout required	integer	Timeout	`100`
min_scale required	integer	Min Scale	`1`
memory required	integer	Memory	`256`
max_scale required	integer	Max Scale	`5`

2.1.33 - Update Cloud Function Cronjob Trigger

2.1.33.1 - 1.3

scpcli scf cloud-function cronjob trigger set
--trigger_id <value>
--timezone <value>
--schedule <value>
--cloud_function_id <value>

Description

update cloud-function cronjob trigger

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
trigger_id required	integer	Trigger ID	`1`
timezone required	string	Timezone	`Asia/Tokyo`
schedule required	string	Schedule	`* * * * 0`
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`

2.1.33.2 - 1.2

scpcli scf cloud-function cronjob trigger set
--trigger_id <value>
--timezone <value>
--schedule <value>
--cloud_function_id <value>

Description

update cloud-function cronjob trigger

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
trigger_id required	integer	Trigger ID	`1`
timezone required	string	Timezone	`Asia/Tokyo`
schedule required	string	Schedule	`* * * * 0`
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`

2.1.33.3 - 1.1

scpcli scf cloud-function cronjob trigger set
--trigger_id <value>
--timezone <value>
--schedule <value>
--cloud_function_id <value>

Description

update cloud-function cronjob trigger

State ACTIVE (DEPRECATED)

Deprecated 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	20260430

Parameters

Name	Type	Description	Example
trigger_id required	integer	Trigger ID	`1`
timezone required	string	Timezone	`Asia/Tokyo`
schedule required	string	Schedule	`* * * * 0`
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`

2.1.33.4 - 1.0

scpcli scf cloud-function cronjob trigger set
--trigger_id <value>
--timezone <value>
--schedule <value>
--cloud_function_id <value>

Description

update cloud-function cronjob trigger

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
trigger_id required	integer	Trigger ID	`1`
timezone required	string	Timezone	`Asia/Tokyo`
schedule required	string	Schedule	`* * * * 0`
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`

2.1.34 - Update Cloud Function Url

2.1.34.1 - 1.3

scpcli scf cloud-function url set
--cloud_function_id <value>
--url_enabled <value>
--public_ip_acl_enabled <value>
[--allow_ips <value>]
[--auth_type <value>]

Description

update cloud-function url

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
url_enabled required	boolean	URL Enabled	`True`
public_ip_acl_enabled required	boolean	Public IP ACL Enabled	`True`
allow_ips optional	array	Allow Ips	-
auth_type optional	string	Auth Type	`NONE`

2.1.34.2 - 1.2

scpcli scf cloud-function url set
--cloud_function_id <value>
--url_enabled <value>
--public_ip_acl_enabled <value>
[--allow_ips <value>]
[--auth_type <value>]

Description

update cloud-function url

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
url_enabled required	boolean	URL Enabled	`True`
public_ip_acl_enabled required	boolean	Public IP ACL Enabled	`True`
allow_ips optional	array	Allow Ips	-
auth_type optional	string	Auth Type	`NONE`

2.1.34.3 - 1.1

scpcli scf cloud-function url set
--cloud_function_id <value>
--url_enabled <value>
--public_ip_acl_enabled <value>
[--allow_ips <value>]
[--auth_type <value>]

Description

update cloud-function url

State ACTIVE (DEPRECATED)

Deprecated 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	20260430

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
url_enabled required	boolean	URL Enabled	`True`
public_ip_acl_enabled required	boolean	Public IP ACL Enabled	`True`
allow_ips optional	array	Allow Ips	-
auth_type optional	string	Auth Type	`NONE`

2.1.34.4 - 1.0

scpcli scf cloud-function url set
--cloud_function_id <value>
--url_enabled <value>
--public_ip_acl_enabled <value>
[--allow_ips <value>]
[--auth_type <value>]

Description

update cloud-function url

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
url_enabled required	boolean	URL Enabled	`True`
public_ip_acl_enabled required	boolean	Public IP ACL Enabled	`True`
allow_ips optional	array	Allow Ips	-
auth_type optional	string	Auth Type	`NONE`

2.1.35 - Update Cloud Function Variables

2.1.35.1 - 1.3

scpcli scf cloud-function variables set
--cloud_function_id <value>
--variables <value>

Description

update cloud-function variables

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
variables required	array	Environment Variables	`'{"key": "sample", "value": "sample"}'`

2.1.35.2 - 1.2

scpcli scf cloud-function variables set
--cloud_function_id <value>
--variables <value>

Description

update cloud-function variables

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
variables required	array	Environment Variables	`'{"key": "sample", "value": "sample"}'`

2.1.35.3 - 1.1

scpcli scf cloud-function variables set
--cloud_function_id <value>
--variables <value>

Description

update cloud-function variables

State ACTIVE (DEPRECATED)

Deprecated 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	20260430

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
variables required	array	Environment Variables	`'{"key": "sample", "value": "sample"}'`

2.1.35.4 - 1.0

scpcli scf cloud-function variables set
--cloud_function_id <value>
--variables <value>

Description

update cloud-function variables

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
variables required	array	Environment Variables	`'{"key": "sample", "value": "sample"}'`

2.1.36 - Update PrivateLink Service

2.1.36.1 - 1.3

scpcli scf privatelink-service set
--cloud_function_id <value>
--privatelink_service_enabled <value>

Description

update PrivateLink Service

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
privatelink_service_enabled required	boolean	PrivateLink Service Enabled	`True`

2.1.36.2 - 1.2

scpcli scf privatelink-service set
--cloud_function_id <value>
--privatelink_service_enabled <value>

Description

update PrivateLink Service

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
cloud_function_id required	string	Cloud Functions ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
privatelink_service_enabled required	boolean	PrivateLink Service Enabled	`True`

3 - Virtual Server

Overview

Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.

This guide provides a brief description of Virtual Server service and how to call CLI.

Version

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Status	Not Before
1.2	CURRENT	-
1.1	DEPRECATED	20260531
1.0	DEPRECATED	20251231

3.1 - CLIs

3.1.1 - Accept a volume transfer

3.1.1.1 - 1.2

scpcli virtualserver volume transfer accept
--transfer_id <value>
--auth_key <value>

Description

Accept a volume transfer.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
transfer_id required	string	Volume Transfer ID	`1ac231be-823b-4a4d-8ff0-aac503a7118a`
auth_key required	string	Auth key	`f5972fdb456897eb`

Responses

Name	Description	Example
id	Volume Transfer ID	1ac231be-823b-4a4d-8ff0-aac503a7118a
name	Volume name	volume01
volume_id	Volume ID	3f500f00-ed80-4566-a057-e31760226f9a

3.1.1.2 - 1.1

scpcli virtualserver volume transfer accept
--transfer_id <value>
--auth_key <value>

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

Name	Type	Description	Example
transfer_id required	string	Volume Transfer ID	`1ac231be-823b-4a4d-8ff0-aac503a7118a`
auth_key required	string	Auth key	`f5972fdb456897eb`

Responses

Name	Description	Example
id	Volume Transfer ID	1ac231be-823b-4a4d-8ff0-aac503a7118a
name	Volume name	volume01
volume_id	Volume ID	3f500f00-ed80-4566-a057-e31760226f9a

3.1.1.3 - 1.0

scpcli virtualserver volume transfer accept
--transfer_id <value>
--auth_key <value>

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

Name	Type	Description	Example
transfer_id required	string	Volume Transfer ID	`1ac231be-823b-4a4d-8ff0-aac503a7118a`
auth_key required	string	Auth key	`f5972fdb456897eb`

Responses

Name	Description	Example
id	Volume Transfer ID	1ac231be-823b-4a4d-8ff0-aac503a7118a
name	Volume name	volume01
volume_id	Volume ID	3f500f00-ed80-4566-a057-e31760226f9a

3.1.2 - Attach Virtual Server Security Group

3.1.2.1 - 1.0

scpcli virtualserver server add security group
--server_id <value>
--security_group_id <value>

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

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
security_group_id required	string	Security Group ID	`c09c3f05-03d9-443f-b27a-40e0f973c75f`

Responses

Name	Description	Example

3.1.3 - Attach Volume to Virtual Server

3.1.3.1 - 1.2

scpcli virtualserver volume attach server
--volume_id <value>
--server_id <value>
[--delete_on_termination <value>]

Description

Attach Volume to Virtual Server.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
volume_id required	string	Volume ID	`3f500f00-ed80-4566-a057-e31760226f9a`
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
delete_on_termination optional	boolean	Delete the boot volume when the server is terminated.	`False`

Responses

Name	Description	Example
delete_on_termination	Delete the boot volume when the server is terminated.	False
device	Device name such as, /dev/vda.	/dev/vda
server_id	Server ID	2a9be312-5d4b-4bc8-b2ae-35100fa9241f
volume_id	Volume ID	3f500f00-ed80-4566-a057-e31760226f9a

3.1.3.2 - 1.1

scpcli virtualserver volume attach server
--volume_id <value>
--server_id <value>
[--delete_on_termination <value>]

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

Name	Type	Description	Example
volume_id required	string	Volume ID	`3f500f00-ed80-4566-a057-e31760226f9a`
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
delete_on_termination optional	boolean	Delete the boot volume when the server is terminated.	`False`

Responses

Name	Description	Example
delete_on_termination	Delete the boot volume when the server is terminated.	False
device	Device name such as, /dev/vda.	/dev/vda
server_id	Server ID	2a9be312-5d4b-4bc8-b2ae-35100fa9241f
volume_id	Volume ID	3f500f00-ed80-4566-a057-e31760226f9a

3.1.3.3 - 1.0

scpcli virtualserver volume attach server
--volume_id <value>
--server_id <value>
[--delete_on_termination <value>]

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

Name	Type	Description	Example
volume_id required	string	Volume ID	`3f500f00-ed80-4566-a057-e31760226f9a`
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
delete_on_termination optional	boolean	Delete the boot volume when the server is terminated.	`False`

Responses

Name	Description	Example
delete_on_termination	Delete the boot volume when the server is terminated.	False
device	Device name such as, /dev/vda.	/dev/vda
server_id	Server ID	2a9be312-5d4b-4bc8-b2ae-35100fa9241f
volume_id	Volume ID	3f500f00-ed80-4566-a057-e31760226f9a

3.1.4 - Create a snapshot

3.1.4.1 - 1.2

scpcli virtualserver volume snapshot create
--volume_id <value>
--name <value>
[--description <value>]
[--force <value>]
[--metadata <value>]

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

Parameters

Name	Type	Description	Example
volume_id required	string	Volume ID	`3f500f00-ed80-4566-a057-e31760226f9a`
name required	string	Snapshot name	`snapshot-1`
description optional	string	Description	`description`
force optional	boolean	Whether to create a snapshot even if the volume is attached	`True`
metadata optional	object	One or more metadata key and value pairs for the snapshot	-

Responses

Name	Description	Example
id	Snapshot ID	cceed636-1f1e-4bb0-b85c-4e5b9e0bf790
created_at	Created at	2025-07-22T09:00:00Z
description	Description	description
metadata	One or more metadata key and value pairs for the snapshot	Metadata
name	Snapshot name	snapshot-1
size	Volume size	104
status	Volume state	available
updated_at	Updated at	2025-07-26T12:00:00Z
user_id	User ID	570907805e5447be84b618450ef52o0t
volume_id	Volume ID	3f500f00-ed80-4566-a057-e31760226f9a

3.1.4.2 - 1.1

scpcli virtualserver volume snapshot create
--volume_id <value>
--name <value>
[--description <value>]
[--force <value>]
[--metadata <value>]

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

Name	Type	Description	Example
volume_id required	string	Volume ID	`3f500f00-ed80-4566-a057-e31760226f9a`
name required	string	Snapshot name	`snapshot-1`
description optional	string	Description	`description`
force optional	boolean	Whether to create a snapshot even if the volume is attached	`True`
metadata optional	object	One or more metadata key and value pairs for the snapshot	-

Responses

Name	Description	Example
id	Snapshot ID	cceed636-1f1e-4bb0-b85c-4e5b9e0bf790
created_at	Created at	2025-07-22T09:00:00Z
description	Description	description
metadata	One or more metadata key and value pairs for the snapshot	Metadata
name	Snapshot name	snapshot-1
size	Volume size	104
status	Volume state	available
updated_at	Updated at	2025-07-26T12:00:00Z
user_id	User ID	570907805e5447be84b618450ef52o0t
volume_id	Volume ID	3f500f00-ed80-4566-a057-e31760226f9a

3.1.4.3 - 1.0

scpcli virtualserver volume snapshot create
--volume_id <value>
--name <value>
[--description <value>]
[--force <value>]
[--metadata <value>]

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

Name	Type	Description	Example
volume_id required	string	Volume ID	`3f500f00-ed80-4566-a057-e31760226f9a`
name required	string	Snapshot name	`snapshot-1`
description optional	string	Description	`description`
force optional	boolean	Whether to create a snapshot even if the volume is attached	`True`
metadata optional	object	One or more metadata key and value pairs for the snapshot	-

Responses

Name	Description	Example
id	Snapshot ID	cceed636-1f1e-4bb0-b85c-4e5b9e0bf790
created_at	Created at	2025-07-22T09:00:00Z
description	Description	description
metadata	One or more metadata key and value pairs for the snapshot	Metadata
name	Snapshot name	snapshot-1
size	Volume size	104
status	Volume state	available
updated_at	Updated at	2025-07-26T12:00:00Z
user_id	User ID	570907805e5447be84b618450ef52o0t
volume_id	Volume ID	3f500f00-ed80-4566-a057-e31760226f9a

3.1.5 - Create a volume transfer

3.1.5.1 - 1.2

scpcli virtualserver volume transfer create
--volume_id <value>
[--name <value>]

Description

Create a volume transfer.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
volume_id required	string	Volume ID	`3f500f00-ed80-4566-a057-e31760226f9a`
name optional	string	Volume name	`volume01`

Responses

Name	Description	Example
id	Volume Transfer ID	1ac231be-823b-4a4d-8ff0-aac503a7118a
auth_key	Auth key	f5972fdb456897eb
created_at	Created at
name	Volume name	volume01
volume_id	Volume ID	3f500f00-ed80-4566-a057-e31760226f9a

3.1.5.2 - 1.1

scpcli virtualserver volume transfer create
--volume_id <value>
[--name <value>]

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

Name	Type	Description	Example
volume_id required	string	Volume ID	`3f500f00-ed80-4566-a057-e31760226f9a`
name optional	string	Volume name	`volume01`

Responses

Name	Description	Example
id	Volume Transfer ID	1ac231be-823b-4a4d-8ff0-aac503a7118a
auth_key	Auth key	f5972fdb456897eb
created_at	Created at
name	Volume name	volume01
volume_id	Volume ID	3f500f00-ed80-4566-a057-e31760226f9a

3.1.5.3 - 1.0

scpcli virtualserver volume transfer create
--volume_id <value>
[--name <value>]

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

Name	Type	Description	Example
volume_id required	string	Volume ID	`3f500f00-ed80-4566-a057-e31760226f9a`
name optional	string	Volume name	`volume01`

Responses

Name	Description	Example
id	Volume Transfer ID	1ac231be-823b-4a4d-8ff0-aac503a7118a
auth_key	Auth key	f5972fdb456897eb
created_at	Created at
name	Volume name	volume01
volume_id	Volume ID	3f500f00-ed80-4566-a057-e31760226f9a

3.1.6 - Create Auto-Scaling Group

3.1.6.1 - 1.2

scpcli virtualserver auto scaling group create
--use_lb_state_check <value>
--subnet_ids <value>
--state_check_delay_time <value>
--server_name_prefix <value>
--name <value>
--min_server_count <value>
--max_server_count <value>
--launch_configuration_id <value>
--desired_server_count_editable <value>
--desired_server_count <value>
[--drain_enabled <value>]
[--drain_timeout <value>]
[--lb_server_groups <value>]
[--notifications <value>]
[--scaling_policies <value>]
[--security_group_ids <value>]
[--tags <value>]

Description

Create Auto-Scaling Group.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
use_lb_state_check required	boolean	Whether LB state check operates or not	`True`
subnet_ids required	array	Subnet ID list	-
state_check_delay_time required	integer	The delay time between ASG VM creation and state check operation	`300`
server_name_prefix required	string	Server name prefix	`server-name-prefix`
name required	string	Auto-Scaling Group name	`auto-scaling-group-name`
min_server_count required	integer	Min server count	`1`
max_server_count required	integer	Max server count	`2`
launch_configuration_id required	string	Launch Configuration ID	`b5aea5a675fc4f6b9e0fcd1288354c5f`
desired_server_count_editable required	boolean	Desired server count editable	`True`
desired_server_count required	integer	Desired server count	`1`
drain_enabled optional	boolean	Drain enabled	`True`
drain_timeout optional	integer	Drain timeout	`300`
lb_server_groups optional	array	LB Server Group list	`'{"id": "d06e87d3-ca9a-461b-8e88-077a542a7335", "port": 8080}'`
notifications optional	array	Auto-Scaling Group notifications	`'{"notification_events": ["SCALE_OUT", "SCALE_OUT_FAIL"], "user_ids": ["570907805e5447be84b618450ef52o0t"]}'`
scaling_policies optional	array	Auto-Scaling Group policy list	`'{"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}'`
security_group_ids optional	array	Security Group ID list	`c09c3f05-03d9-443f-b27a-40e0f973c75f`
tags optional	array	Tags	`'{"key": "Key", "value": "Value"}'`

Responses

Name	Description	Example
id	LB Server Group ID	d06e87d3-ca9a-461b-8e88-077a542a7335
port	LB Server Group port	8080

3.1.6.2 - 1.1

scpcli virtualserver auto scaling group create
--subnet_ids <value>
--server_name_prefix <value>
--name <value>
--min_server_count <value>
--max_server_count <value>
--launch_configuration_id <value>
--desired_server_count_editable <value>
--desired_server_count <value>
[--drain_enabled <value>]
[--drain_timeout <value>]
[--lb_server_groups <value>]
[--notifications <value>]
[--scaling_policies <value>]
[--security_group_ids <value>]
[--tags <value>]

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

Name	Type	Description	Example
subnet_ids required	array	Subnet ID list	-
server_name_prefix required	string	Server name prefix	`server-name-prefix`
name required	string	Auto-Scaling Group name	`auto-scaling-group-name`
min_server_count required	integer	Min server count	`1`
max_server_count required	integer	Max server count	`2`
launch_configuration_id required	string	Launch Configuration ID	`b5aea5a675fc4f6b9e0fcd1288354c5f`
desired_server_count_editable required	boolean	Desired server count editable	`True`
desired_server_count required	integer	Desired server count	`1`
drain_enabled optional	boolean	Drain enabled	`True`
drain_timeout optional	integer	Drain timeout	`300`
lb_server_groups optional	array	LB Server Group list	`'{"id": "d06e87d3-ca9a-461b-8e88-077a542a7335", "port": 8080}'`
notifications optional	array	Auto-Scaling Group notifications	`'{"notification_events": ["SCALE_OUT", "SCALE_OUT_FAIL"], "user_ids": ["570907805e5447be84b618450ef52o0t"]}'`
scaling_policies optional	array	Auto-Scaling Group policy list	`'{"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}'`
security_group_ids optional	array	Security Group ID list	`c09c3f05-03d9-443f-b27a-40e0f973c75f`
tags optional	array	Tags	`'{"key": "Key", "value": "Value"}'`

Responses

Name	Description	Example
id	LB Server Group ID	d06e87d3-ca9a-461b-8e88-077a542a7335
port	LB Server Group port	8080

3.1.6.3 - 1.0

scpcli virtualserver auto scaling group create
--subnet_ids <value>
--server_name_prefix <value>
--name <value>
--min_server_count <value>
--max_server_count <value>
--launch_configuration_id <value>
--desired_server_count_editable <value>
--desired_server_count <value>
[--drain_enabled <value>]
[--drain_timeout <value>]
[--lb_server_groups <value>]
[--notifications <value>]
[--scaling_policies <value>]
[--security_group_ids <value>]
[--tags <value>]

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

Name	Type	Description	Example
subnet_ids required	array	Subnet ID list	-
server_name_prefix required	string	Server name prefix	`server-name-prefix`
name required	string	Auto-Scaling Group name	`auto-scaling-group-name`
min_server_count required	integer	Min server count	`1`
max_server_count required	integer	Max server count	`2`
launch_configuration_id required	string	Launch Configuration ID	`b5aea5a675fc4f6b9e0fcd1288354c5f`
desired_server_count_editable required	boolean	Desired server count editable	`True`
desired_server_count required	integer	Desired server count	`1`
drain_enabled optional	boolean	Drain enabled	`True`
drain_timeout optional	integer	Drain timeout	`300`
lb_server_groups optional	array	LB Server Group list	`'{"id": "d06e87d3-ca9a-461b-8e88-077a542a7335", "port": 8080}'`
notifications optional	array	Auto-Scaling Group notifications	`'{"notification_events": ["SCALE_OUT", "SCALE_OUT_FAIL"], "user_ids": ["570907805e5447be84b618450ef52o0t"]}'`
scaling_policies optional	array	Auto-Scaling Group policy list	`'{"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}'`
security_group_ids optional	array	Security Group ID list	`c09c3f05-03d9-443f-b27a-40e0f973c75f`
tags optional	array	Tags	`'{"key": "Key", "value": "Value"}'`

Responses

Name	Description	Example
id	LB Server Group ID	d06e87d3-ca9a-461b-8e88-077a542a7335
port	LB Server Group port	8080

3.1.7 - Create Auto-Scaling Group Notification

3.1.7.1 - 1.2

scpcli virtualserver auto scaling group notification create
--auto_scaling_group_id <value>
--user_ids <value>
--notification_events <value>

Description

Create Auto-Scaling Group notification.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`
user_ids required	array	User ID list	`570907805e5447be84b618450ef52o0t`
notification_events required	array	Auto-Scaling Group notification event list	`'{}'`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID	a8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_id	Auto-Scaling Group ID	52613bd852b04b39adcb15a8364d856d
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
notification_events	Auto-Scaling Group notification event list	[‘SCALE_OUT’, ‘SCALE_OUT_FAIL’]
notification_state	Auto-Scaling Group notification state	ACTIVE
user_email	User email	scpuser@samsung.com
user_id	User ID	570907805e5447be84b618450ef52o0t
user_name	User name	scpuser

3.1.7.2 - 1.1

scpcli virtualserver auto scaling group notification create
--auto_scaling_group_id <value>
--user_ids <value>
--notification_events <value>

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

Name	Type	Description	Example
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`
user_ids required	array	User ID list	`570907805e5447be84b618450ef52o0t`
notification_events required	array	Auto-Scaling Group notification event list	`'{}'`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID	a8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_id	Auto-Scaling Group ID	52613bd852b04b39adcb15a8364d856d
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
notification_events	Auto-Scaling Group notification event list	[‘SCALE_OUT’, ‘SCALE_OUT_FAIL’]
notification_state	Auto-Scaling Group notification state	ACTIVE
user_email	User email	scpuser@samsung.com
user_id	User ID	570907805e5447be84b618450ef52o0t
user_name	User name	scpuser

3.1.7.3 - 1.0

scpcli virtualserver auto scaling group notification create
--auto_scaling_group_id <value>
--user_ids <value>
--notification_events <value>

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

Name	Type	Description	Example
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`
user_ids required	array	User ID list	`570907805e5447be84b618450ef52o0t`
notification_events required	array	Auto-Scaling Group notification event list	`'{}'`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID	a8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_id	Auto-Scaling Group ID	52613bd852b04b39adcb15a8364d856d
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
notification_events	Auto-Scaling Group notification event list	[‘SCALE_OUT’, ‘SCALE_OUT_FAIL’]
notification_state	Auto-Scaling Group notification state	ACTIVE
user_email	User email	scpuser@samsung.com
user_id	User ID	570907805e5447be84b618450ef52o0t
user_name	User name	scpuser

3.1.8 - Create Auto-Scaling Group Policy

3.1.8.1 - 1.2

scpcli virtualserver auto scaling group policy create
--auto_scaling_group_id <value>
--threshold <value>
--scale_value <value>
--scale_type <value>
--scale_method <value>
--name <value>
--metric_type <value>
--metric_method <value>
--evaluation_minutes <value>
--cooldown_seconds <value>
--comparison_operator <value>

Description

Create Auto-Scaling Group policy.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`
threshold required	integer	Threshold	`60`
scale_value required	integer	Scale value	`10`
scale_type required	string	Scale type	`SCALE_OUT`
scale_method required	string	Scale method	`AMOUNT`
name required	string	Policy name	`policy-name`
metric_type required	string	Metric type	`CPU`
metric_method required	string	Metric method	`AVG`
evaluation_minutes required	integer	Evaluation minutes	`5`
cooldown_seconds required	integer	Cooldown seconds	`300`
comparison_operator required	string	Comparison operator	`ge`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID	a8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_id	Auto-Scaling Group ID	52613bd852b04b39adcb15a8364d856d
comparison_operator	Comparison operator	ge
cooldown_seconds	Cooldown seconds	300
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
evaluation_minutes	Evaluation minutes	5
metric_method	Metric method	AVG
metric_type	Metric type	CPU
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Policy name	policy-name
scale_method	Scale method	AMOUNT
scale_type	Scale type	SCALE_OUT
scale_value	Scale value	10
state	Policy state	ACTIVE
threshold	Threshold	60
threshold_unit	Threshold unit	%

3.1.8.2 - 1.1

scpcli virtualserver auto scaling group policy create
--auto_scaling_group_id <value>
--threshold <value>
--scale_value <value>
--scale_type <value>
--scale_method <value>
--name <value>
--metric_type <value>
--metric_method <value>
--evaluation_minutes <value>
--cooldown_seconds <value>
--comparison_operator <value>

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

Name	Type	Description	Example
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`
threshold required	integer	Threshold	`60`
scale_value required	integer	Scale value	`10`
scale_type required	string	Scale type	`SCALE_OUT`
scale_method required	string	Scale method	`AMOUNT`
name required	string	Policy name	`policy-name`
metric_type required	string	Metric type	`CPU`
metric_method required	string	Metric method	`AVG`
evaluation_minutes required	integer	Evaluation minutes	`5`
cooldown_seconds required	integer	Cooldown seconds	`300`
comparison_operator required	string	Comparison operator	`ge`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID	a8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_id	Auto-Scaling Group ID	52613bd852b04b39adcb15a8364d856d
comparison_operator	Comparison operator	ge
cooldown_seconds	Cooldown seconds	300
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
evaluation_minutes	Evaluation minutes	5
metric_method	Metric method	AVG
metric_type	Metric type	CPU
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Policy name	policy-name
scale_method	Scale method	AMOUNT
scale_type	Scale type	SCALE_OUT
scale_value	Scale value	10
state	Policy state	ACTIVE
threshold	Threshold	60
threshold_unit	Threshold unit	%

3.1.8.3 - 1.0

scpcli virtualserver auto scaling group policy create
--auto_scaling_group_id <value>
--threshold <value>
--scale_value <value>
--scale_type <value>
--scale_method <value>
--name <value>
--metric_type <value>
--metric_method <value>
--evaluation_minutes <value>
--cooldown_seconds <value>
--comparison_operator <value>

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

Name	Type	Description	Example
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`
threshold required	integer	Threshold	`60`
scale_value required	integer	Scale value	`10`
scale_type required	string	Scale type	`SCALE_OUT`
scale_method required	string	Scale method	`AMOUNT`
name required	string	Policy name	`policy-name`
metric_type required	string	Metric type	`CPU`
metric_method required	string	Metric method	`AVG`
evaluation_minutes required	integer	Evaluation minutes	`5`
cooldown_seconds required	integer	Cooldown seconds	`300`
comparison_operator required	string	Comparison operator	`ge`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID	a8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_id	Auto-Scaling Group ID	52613bd852b04b39adcb15a8364d856d
comparison_operator	Comparison operator	ge
cooldown_seconds	Cooldown seconds	300
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
evaluation_minutes	Evaluation minutes	5
metric_method	Metric method	AVG
metric_type	Metric type	CPU
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Policy name	policy-name
scale_method	Scale method	AMOUNT
scale_type	Scale type	SCALE_OUT
scale_value	Scale value	10
state	Policy state	ACTIVE
threshold	Threshold	60
threshold_unit	Threshold unit	%

3.1.9 - Create Auto-Scaling Group Schedule

3.1.9.1 - 1.2

scpcli virtualserver auto scaling group schedule create
--auto_scaling_group_id <value>
--timezone <value>
--start_date <value>
--name <value>
--minute <value>
--hour <value>
--frequency <value>
[--day_of_month <value>]
[--day_of_week <value>]
[--description <value>]
[--desired_server_count <value>]
[--end_date <value>]
[--max_server_count <value>]
[--min_server_count <value>]
[--state <value>]

Description

Create Auto-Scaling Group schedule.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`
timezone required	string	Timezone	`Asia/Seoul`
start_date required	string	Start date	`2024-01-01`
name required	string	Schedule name	`schedulename`
minute required	integer	Minute	`0`
hour required	integer	Hour	`9`
frequency required	string	Frequency	`WEEKLY`
day_of_month optional	string	Day of the month	`-1,1`
day_of_week optional	string	Day of the week	`SU,SA`
description optional	string	Description	`description`
desired_server_count optional	integer	Desired server count	`1`
end_date optional	string	End date	`2025-01-01`
max_server_count optional	integer	Max server count	`2`
min_server_count optional	integer	Min server count	`1`
state optional	string	Schedule state	`ACTIVE`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID	a8f10467abfc4b87b64614ab36eb9ae4
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
day_of_month	Day of the month	-1,1
day_of_week	Day of the week	SU,SA
description	Description	description
desired_server_count	Desired server count	1
end_date	End date	2025-01-01
frequency	Frequency	WEEKLY
hour	Hour	9
max_server_count	Max server count	2
min_server_count	Min server count	1
minute	Minute	0
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Schedule name	schedulename
start_date	Start date	2024-01-01
state	Schedule state	ACTIVE
timezone	Timezone	Asia/Seoul

3.1.9.2 - 1.1

scpcli virtualserver auto scaling group schedule create
--auto_scaling_group_id <value>
--timezone <value>
--start_date <value>
--name <value>
--minute <value>
--hour <value>
--frequency <value>
[--day_of_month <value>]
[--day_of_week <value>]
[--description <value>]
[--desired_server_count <value>]
[--end_date <value>]
[--max_server_count <value>]
[--min_server_count <value>]
[--state <value>]

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

Name	Type	Description	Example
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`
timezone required	string	Timezone	`Asia/Seoul`
start_date required	string	Start date	`2024-01-01`
name required	string	Schedule name	`schedulename`
minute required	integer	Minute	`0`
hour required	integer	Hour	`9`
frequency required	string	Frequency	`WEEKLY`
day_of_month optional	string	Day of the month	`-1,1`
day_of_week optional	string	Day of the week	`SU,SA`
description optional	string	Description	`description`
desired_server_count optional	integer	Desired server count	`1`
end_date optional	string	End date	`2025-01-01`
max_server_count optional	integer	Max server count	`2`
min_server_count optional	integer	Min server count	`1`
state optional	string	Schedule state	`ACTIVE`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID	a8f10467abfc4b87b64614ab36eb9ae4
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
day_of_month	Day of the month	-1,1
day_of_week	Day of the week	SU,SA
description	Description	description
desired_server_count	Desired server count	1
end_date	End date	2025-01-01
frequency	Frequency	WEEKLY
hour	Hour	9
max_server_count	Max server count	2
min_server_count	Min server count	1
minute	Minute	0
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Schedule name	schedulename
start_date	Start date	2024-01-01
state	Schedule state	ACTIVE
timezone	Timezone	Asia/Seoul

3.1.9.3 - 1.0

scpcli virtualserver auto scaling group schedule create
--auto_scaling_group_id <value>
--timezone <value>
--start_date <value>
--name <value>
--minute <value>
--hour <value>
--frequency <value>
[--day_of_month <value>]
[--day_of_week <value>]
[--description <value>]
[--desired_server_count <value>]
[--end_date <value>]
[--max_server_count <value>]
[--min_server_count <value>]
[--state <value>]

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

Name	Type	Description	Example
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`
timezone required	string	Timezone	`Asia/Seoul`
start_date required	string	Start date	`2024-01-01`
name required	string	Schedule name	`schedulename`
minute required	integer	Minute	`0`
hour required	integer	Hour	`9`
frequency required	string	Frequency	`WEEKLY`
day_of_month optional	string	Day of the month	`-1,1`
day_of_week optional	string	Day of the week	`SU,SA`
description optional	string	Description	`description`
desired_server_count optional	integer	Desired server count	`1`
end_date optional	string	End date	`2025-01-01`
max_server_count optional	integer	Max server count	`2`
min_server_count optional	integer	Min server count	`1`
state optional	string	Schedule state	`ACTIVE`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID	a8f10467abfc4b87b64614ab36eb9ae4
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
day_of_month	Day of the month	-1,1
day_of_week	Day of the week	SU,SA
description	Description	description
desired_server_count	Desired server count	1
end_date	End date	2025-01-01
frequency	Frequency	WEEKLY
hour	Hour	9
max_server_count	Max server count	2
min_server_count	Min server count	1
minute	Minute	0
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Schedule name	schedulename
start_date	Start date	2024-01-01
state	Schedule state	ACTIVE
timezone	Timezone	Asia/Seoul

3.1.10 - Create Image

3.1.10.1 - 1.2

scpcli virtualserver image create
--url <value>
--os_distro <value>
--name <value>
[--container_format <value>]
[--disk_format <value>]
[--min_disk <value>]
[--min_ram <value>]
[--protected <value>]
[--tags <value>]
[--visibility <value>]

Description

Create Image.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
url required	string	Object Storage URL for Image file (only qcow2 format allowed)	`https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2`
os_distro required	string	OS distribution of the image to be uploaded	`alma`
name required	string	Image name	`imagename`
container_format optional	string	Container format	`bare`
disk_format optional	string	Disk format	`qcow2`
min_disk optional	integer	Minimum disk capacity (GB) of the Image to be created	`100`
min_ram optional	integer	Minimum RAM capacity (GB) of the Image to be created	`0`
protected optional	boolean	whether Image deletion is prohibited	`False`
tags optional	array	Tags	`'{"key": "Key", "value": "Value"}'`
visibility optional	string	Indicates access permissions for the Image. Private: Can be used only within the Account, Shared: Can be shared between Accounts	`private`

Responses

Name	Description	Example
id	Image ID	70a599e0-31e7-49b7-b260-868f441e862b
checksum	MD5 hash of the entire image data. and this field could be used to verify the integrity of image.	7538e0fcb56e0e272cfd89eb384d6613
container_format	Container format	bare
created_at	Created at	2025-07-22T09:00:00Z
disk_format	Disk format	qcow2
file	The URL for the virtual server image file	/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file
min_disk	Minimum disk capacity (GB) of the Image to be created	100
min_ram	Minimum RAM capacity (GB) of the Image to be created	0
name	Image name	imagename
os_distro	OS distribution of the image to be uploaded	alma
os_hash_algo	OS hash algorithm used to verify image integrity	sha512
os_hash_value	The actual digest of the image binary, calculated with the algorithm indicated by os_hash_algo. The value is presented as a hexadecimal string.	c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99
os_hidden	Whether the image is hidden	False
owner	Owner account ID	a8f10467abfc4b87b64614ab36eb9ae4
owner_account_name	Owner account name	AccountName
owner_user_name	Owner user name	user@samsung.com
protected	whether Image deletion is prohibited	False
root_device_name	Root device name	/dev/vda
scp_gpu_driver	K8s GPU Image driver version	535.183.06
scp_image_type	Image type	custom
scp_k8s_version	K8S version	v1.28.7
scp_original_image_type	Original Image type	standard
scp_os_build_version	OS build version	20250101
scp_os_version	OS version	8.8
size	Image size	2429747200
status	Image status	active
updated_at	Updated at	2025-07-26T12:00:00Z
url	Object Storage URL for Image file (only qcow2 format allowed)	https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2
virtual_size	Virtual size	17179869184
visibility	Indicates access permissions for the Image. Private: Can be used only within the Account, Shared: Can be shared between Accounts	private
volumes	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}]

3.1.10.2 - 1.1

scpcli virtualserver image create
--url <value>
--os_distro <value>
--name <value>
[--container_format <value>]
[--disk_format <value>]
[--min_disk <value>]
[--min_ram <value>]
[--protected <value>]
[--tags <value>]
[--visibility <value>]

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

Name	Type	Description	Example
url required	string	Object Storage URL for Image file (only qcow2 format allowed)	`https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2`
os_distro required	string	OS distribution of the image to be uploaded	`alma`
name required	string	Image name	`imagename`
container_format optional	string	Container format	`bare`
disk_format optional	string	Disk format	`qcow2`
min_disk optional	integer	Minimum disk capacity (GB) of the Image to be created	`100`
min_ram optional	integer	Minimum RAM capacity (GB) of the Image to be created	`0`
protected optional	boolean	whether Image deletion is prohibited	`False`
tags optional	array	Tags	`'{"key": "Key", "value": "Value"}'`
visibility optional	string	Indicates access permissions for the Image. Private: Can be used only within the Account, Shared: Can be shared between Accounts	`private`

Responses

Name	Description	Example
id	Image ID	70a599e0-31e7-49b7-b260-868f441e862b
checksum	MD5 hash of the entire image data. and this field could be used to verify the integrity of image.	7538e0fcb56e0e272cfd89eb384d6613
container_format	Container format	bare
created_at	Created at	2025-07-22T09:00:00Z
disk_format	Disk format	qcow2
file	The URL for the virtual server image file	/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file
min_disk	Minimum disk capacity (GB) of the Image to be created	100
min_ram	Minimum RAM capacity (GB) of the Image to be created	0
name	Image name	imagename
os_distro	OS distribution of the image to be uploaded	alma
os_hash_algo	OS hash algorithm used to verify image integrity	sha512
os_hash_value	The actual digest of the image binary, calculated with the algorithm indicated by os_hash_algo. The value is presented as a hexadecimal string.	c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99
os_hidden	Whether the image is hidden	False
owner	Owner account ID	a8f10467abfc4b87b64614ab36eb9ae4
owner_account_name	Owner account name	AccountName
owner_user_name	Owner user name	user@samsung.com
protected	whether Image deletion is prohibited	False
root_device_name	Root device name	/dev/vda
scp_image_type	Image type	custom
scp_k8s_version	K8S version	v1.28.7
scp_original_image_type	Original Image type	standard
scp_os_build_version	OS build version	20250101
scp_os_version	OS version	8.8
size	Image size	2429747200
status	Image status	active
updated_at	Updated at	2025-07-26T12:00:00Z
url	Object Storage URL for Image file (only qcow2 format allowed)	https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2
virtual_size	Virtual size	17179869184
visibility	Indicates access permissions for the Image. Private: Can be used only within the Account, Shared: Can be shared between Accounts	private
volumes	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}]

3.1.10.3 - 1.0

scpcli virtualserver image create
--url <value>
--os_distro <value>
--name <value>
[--container_format <value>]
[--disk_format <value>]
[--min_disk <value>]
[--min_ram <value>]
[--protected <value>]
[--tags <value>]
[--visibility <value>]

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

Name	Type	Description	Example
url required	string	Object Storage URL for Image file (only qcow2 format allowed)	`https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2`
os_distro required	string	OS distribution of the image to be uploaded	`alma`
name required	string	Image name	`imagename`
container_format optional	string	Container format	`bare`
disk_format optional	string	Disk format	`qcow2`
min_disk optional	integer	Minimum disk capacity (GB) of the Image to be created	`100`
min_ram optional	integer	Minimum RAM capacity (GB) of the Image to be created	`0`
protected optional	boolean	whether Image deletion is prohibited	`False`
tags optional	array	Tags	`'{"key": "Key", "value": "Value"}'`
visibility optional	string	Indicates access permissions for the Image. Private: Can be used only within the Account, Shared: Can be shared between Accounts	`private`

Responses

Name	Description	Example
id	Image ID	70a599e0-31e7-49b7-b260-868f441e862b
checksum	MD5 hash of the entire image data. and this field could be used to verify the integrity of image.	7538e0fcb56e0e272cfd89eb384d6613
container_format	Container format	bare
created_at	Created at	2025-07-22T09:00:00Z
disk_format	Disk format	qcow2
file	The URL for the virtual server image file	/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file
min_disk	Minimum disk capacity (GB) of the Image to be created	100
min_ram	Minimum RAM capacity (GB) of the Image to be created	0
name	Image name	imagename
os_distro	OS distribution of the image to be uploaded	alma
os_hash_algo	OS hash algorithm used to verify image integrity	sha512
os_hash_value	The actual digest of the image binary, calculated with the algorithm indicated by os_hash_algo. The value is presented as a hexadecimal string.	c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99
os_hidden	Whether the image is hidden	False
owner	Owner account ID	a8f10467abfc4b87b64614ab36eb9ae4
owner_account_name	Owner account name	AccountName
owner_user_name	Owner user name	user@samsung.com
protected	whether Image deletion is prohibited	False
root_device_name	Root device name	/dev/vda
scp_image_type	Image type	custom
scp_k8s_version	K8S version	v1.28.7
scp_original_image_type	Original Image type	standard
scp_os_build_version	OS build version	20250101
scp_os_version	OS version	8.8
size	Image size	2429747200
status	Image status	active
updated_at	Updated at	2025-07-26T12:00:00Z
url	Object Storage URL for Image file (only qcow2 format allowed)	https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2
virtual_size	Virtual size	17179869184
visibility	Indicates access permissions for the Image. Private: Can be used only within the Account, Shared: Can be shared between Accounts	private
volumes	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}]

3.1.11 - Create Image member

3.1.11.1 - 1.2

scpcli virtualserver image add member
--image_id <value>
--member_id <value>

Description

Add account ID as a shared Image member.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
image_id required	string	Image ID	`70a599e0-31e7-49b7-b260-868f441e862b`
member_id required	string	Shared Image member ID	`a8f10467abfc4b87b64614ab36eb9ae4`

Responses

Name	Description	Example
created_at	Created at	2025-07-22T09:00:00Z
image_id	Image ID	70a599e0-31e7-49b7-b260-868f441e862b
member_id	Shared Image member ID	a8f10467abfc4b87b64614ab36eb9ae4
status	Status of this Image member. Value of one of pending, accepted, rejected.	pending
updated_at	Updated at	2025-07-26T12:00:00Z

3.1.11.2 - 1.1

scpcli virtualserver image add member
--image_id <value>
--member_id <value>

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

Name	Type	Description	Example
image_id required	string	Image ID	`70a599e0-31e7-49b7-b260-868f441e862b`
member_id required	string	Shared Image member ID	`a8f10467abfc4b87b64614ab36eb9ae4`

Responses

Name	Description	Example
created_at	Created at	2025-07-22T09:00:00Z
image_id	Image ID	70a599e0-31e7-49b7-b260-868f441e862b
member_id	Shared Image member ID	a8f10467abfc4b87b64614ab36eb9ae4
status	Status of this Image member. Value of one of pending, accepted, rejected.	pending
updated_at	Updated at	2025-07-26T12:00:00Z

3.1.11.3 - 1.0

scpcli virtualserver image add member
--image_id <value>
--member_id <value>

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

Name	Type	Description	Example
image_id required	string	Image ID	`70a599e0-31e7-49b7-b260-868f441e862b`
member_id required	string	Shared Image member ID	`a8f10467abfc4b87b64614ab36eb9ae4`

Responses

Name	Description	Example
created_at	Created at	2025-07-22T09:00:00Z
image_id	Image ID	70a599e0-31e7-49b7-b260-868f441e862b
member_id	Shared Image member ID	a8f10467abfc4b87b64614ab36eb9ae4
status	Status of this Image member. Value of one of pending, accepted, rejected.	pending
updated_at	Updated at	2025-07-26T12:00:00Z

3.1.12 - Create Keypair

3.1.12.1 - 1.2

scpcli virtualserver keypair create
--name <value>
[--public_key <value>]
[--tags <value>]

Description

Create a new Keypair or Import a Public Key.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
name required	string	Keypair name	`keypairname`
public_key optional	string	Public Key	`ssh-rsa fakeKey Generated-by-SCP`
tags optional	array	Tags	`'{"key": "Key", "value": "Value"}'`

Responses

Name	Description	Example
fingerprint	Fingerprint	7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd
name	Keypair name	keypairname
private_key	Private key	—–BEGIN RSA PRIVATE KEY—–
fakeKey
—–END RSA PRIVATE KEY—–
public_key	Public Key	ssh-rsa fakeKey Generated-by-SCP
type	Keypair type	ssh

3.1.12.2 - 1.1

scpcli virtualserver keypair create
--name <value>
[--public_key <value>]
[--tags <value>]

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

Name	Type	Description	Example
name required	string	Keypair name	`keypairname`
public_key optional	string	Public Key	`ssh-rsa fakeKey Generated-by-SCP`
tags optional	array	Tags	`'{"key": "Key", "value": "Value"}'`

Responses

Name	Description	Example
fingerprint	Fingerprint	7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd
name	Keypair name	keypairname
private_key	Private key	—–BEGIN RSA PRIVATE KEY—–
fakeKey
—–END RSA PRIVATE KEY—–
public_key	Public Key	ssh-rsa fakeKey Generated-by-SCP
type	Keypair type	ssh

3.1.12.3 - 1.0

scpcli virtualserver keypair create
--name <value>
[--public_key <value>]
[--tags <value>]

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

Name	Type	Description	Example
name required	string	Keypair name	`keypairname`
public_key optional	string	Public Key	`ssh-rsa fakeKey Generated-by-SCP`
tags optional	array	Tags	`'{"key": "Key", "value": "Value"}'`

Responses

Name	Description	Example
fingerprint	Fingerprint	7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd
name	Keypair name	keypairname
private_key	Private key	—–BEGIN RSA PRIVATE KEY—–
fakeKey
—–END RSA PRIVATE KEY—–
public_key	Public Key	ssh-rsa fakeKey Generated-by-SCP
type	Keypair type	ssh

3.1.13 - Create Launch Configuration

3.1.13.1 - 1.2

scpcli virtualserver launch configuration create
--server_type_id <value>
--name <value>
--keypair_name <value>
--image_id <value>
[--tags <value>]
[--user_data <value>]
[--volumes <value>]

Description

Create Launch Configuration.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
server_type_id required	string	Server type ID	`s1v1m2`
name required	string	Launch Configuration name	`launch-configuration-name`
keypair_name required	string	Keypair name	`keypairname`
image_id required	string	Image ID	`70a599e0-31e7-49b7-b260-868f441e862b`
tags optional	array	Tags	`'{"key": "Key", "value": "Value"}'`
user_data optional	string	A script that runs at the start of a server on Auto-Scaling Group that will use Launch Configuration.It must be Base64-encoded string and must not exceed 45,000 bytes.	`IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==`
volumes optional	array	Volumes	`'{"boot_index": 0, "size": 104, "type": "SSD"}'`

Responses

Name	Description	Example
boot_index	Boot index	0
max_iops	The number of distinct read or write operations a volume can process in a single second.	10000
max_throughput	The actual amount of data (volume) transferred to or from the storage device per second.	500
size	Volume size	104
type	Volume type	SSD

3.1.13.2 - 1.1

scpcli virtualserver launch configuration create
--server_type_id <value>
--name <value>
--keypair_name <value>
--image_id <value>
[--tags <value>]
[--user_data <value>]
[--volumes <value>]

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

Name	Type	Description	Example
server_type_id required	string	Server type ID	`s1v1m2`
name required	string	Launch Configuration name	`launch-configuration-name`
keypair_name required	string	Keypair name	`keypairname`
image_id required	string	Image ID	`70a599e0-31e7-49b7-b260-868f441e862b`
tags optional	array	Tags	`'{"key": "Key", "value": "Value"}'`
user_data optional	string	A script that runs at the start of a server on Auto-Scaling Group that will use Launch Configuration.It must be Base64-encoded string and must not exceed 45,000 bytes.	`IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==`
volumes optional	array	Volumes	`'{"boot_index": 0, "size": 104, "type": "SSD"}'`

Responses

Name	Description	Example
boot_index	Boot index	0
size	Volume size	104
type	Volume type	SSD

3.1.13.3 - 1.0

scpcli virtualserver launch configuration create
--server_type_id <value>
--name <value>
--keypair_name <value>
--image_id <value>
[--tags <value>]
[--user_data <value>]
[--volumes <value>]

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

Name	Type	Description	Example
server_type_id required	string	Server type ID	`s1v1m2`
name required	string	Launch Configuration name	`launch-configuration-name`
keypair_name required	string	Keypair name	`keypairname`
image_id required	string	Image ID	`70a599e0-31e7-49b7-b260-868f441e862b`
tags optional	array	Tags	`'{"key": "Key", "value": "Value"}'`
user_data optional	string	A script that runs at the start of a server on Auto-Scaling Group that will use Launch Configuration.It must be Base64-encoded string and must not exceed 45,000 bytes.	`IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==`
volumes optional	array	Volumes	`'{"boot_index": 0, "size": 104, "type": "SSD"}'`

Responses

Name	Description	Example
boot_index	Boot index	0
size	Volume size	104
type	Volume type	SSD

3.1.14 - Create Server Group

3.1.14.1 - 1.2

scpcli virtualserver server group create
--policy <value>
--name <value>
[--tags <value>]

Description

Create server group.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
policy required	string	Server Group policy	`anti-affinity`
name required	string	Server Group name	`server-group`
tags optional	array	Tags	`'{"key": "Key", "value": "Value"}'`

Responses

Name	Description	Example
id	Server Group ID	616fb98f-46ca-475e-917e-2563e5a8cd19
account_id	Account ID	a8f10467abfc4b87b64614ab36eb9ae4
members	List of Virtual Servers belonging to Server Group	[‘2a9be312-5d4b-4bc8-b2ae-35100fa9241f’]
name	Server Group name	server-group
partition_size	Size of partition when server group policy is partition	3
policy	Server Group policy	anti-affinity
user_id	User ID	570907805e5447be84b618450ef52o0t

3.1.14.2 - 1.1

scpcli virtualserver server group create
--policy <value>
--name <value>
[--tags <value>]

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

Name	Type	Description	Example
policy required	string	Server Group policy	`anti-affinity`
name required	string	Server Group name	`server-group`
tags optional	array	Tags	`'{"key": "Key", "value": "Value"}'`

Responses

Name	Description	Example
id	Server Group ID	616fb98f-46ca-475e-917e-2563e5a8cd19
account_id	Account ID	a8f10467abfc4b87b64614ab36eb9ae4
members	List of Virtual Servers belonging to Server Group	[‘2a9be312-5d4b-4bc8-b2ae-35100fa9241f’]
name	Server Group name	server-group
partition_size	Size of partition when server group policy is partition	3
policy	Server Group policy	anti-affinity
user_id	User ID	570907805e5447be84b618450ef52o0t

3.1.14.3 - 1.0

scpcli virtualserver server group create
--policy <value>
--name <value>
[--tags <value>]

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

Name	Type	Description	Example
policy required	string	Server Group policy	`anti-affinity`
name required	string	Server Group name	`server-group`
tags optional	array	Tags	`'{"key": "Key", "value": "Value"}'`

Responses

Name	Description	Example
id	Server Group ID	616fb98f-46ca-475e-917e-2563e5a8cd19
account_id	Account ID	a8f10467abfc4b87b64614ab36eb9ae4
members	List of Virtual Servers belonging to Server Group	[‘2a9be312-5d4b-4bc8-b2ae-35100fa9241f’]
name	Server Group name	server-group
partition_size	Size of partition when server group policy is partition	3
policy	Server Group policy	anti-affinity
user_id	User ID	570907805e5447be84b618450ef52o0t

3.1.15 - Create Server Interface

3.1.15.1 - 1.2

scpcli virtualserver server add interface
--server_id <value>
[--fixed_ips <value>]
[--port_id <value>]
[--subnet_id <value>]

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

Parameters

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
fixed_ips optional	array	Fixed IP list	`'{"ip_address": "192.169.3.2"}'`
port_id optional	string	Port ID	`91424c08-0b26-49fb-9808-ed042292ceef`
subnet_id optional	string	Subnet ID	`78b2ee3f074145c580ab6abac4821f97`

Responses

Name	Description	Example
ip_address	IP address	192.169.3.2

3.1.15.2 - 1.1

scpcli virtualserver server add interface
--server_id <value>
[--fixed_ips <value>]
[--port_id <value>]
[--subnet_id <value>]

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

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
fixed_ips optional	array	Fixed IP list	`'{"ip_address": "192.169.3.2"}'`
port_id optional	string	Port ID	`91424c08-0b26-49fb-9808-ed042292ceef`
subnet_id optional	string	Subnet ID	`78b2ee3f074145c580ab6abac4821f97`

Responses

Name	Description	Example
ip_address	IP address	192.169.3.2

3.1.15.3 - 1.0

scpcli virtualserver server add interface
--server_id <value>
[--fixed_ips <value>]
[--port_id <value>]
[--subnet_id <value>]

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

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
fixed_ips optional	array	Fixed IP list	`'{"ip_address": "192.169.3.2"}'`
port_id optional	string	Port ID	`91424c08-0b26-49fb-9808-ed042292ceef`
subnet_id optional	string	Subnet ID	`78b2ee3f074145c580ab6abac4821f97`

Responses

Name	Description	Example
ip_address	IP address	192.169.3.2

3.1.16 - Create Server Interface Nat

3.1.16.1 - 1.2

scpcli virtualserver server interface add static nat
--port_id <value>
--server_id <value>
--publicip_id <value>

Description

Create Server Interface Public Nat.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
port_id required	string	Port ID	`91424c08-0b26-49fb-9808-ed042292ceef`
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
publicip_id required	string	Public IP ID	`615fa9cd5cff486c9de679b3ce63e601`

Responses

Name	Description	Example

3.1.16.2 - 1.1

scpcli virtualserver server interface add static nat
--port_id <value>
--server_id <value>
--publicip_id <value>

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

Name	Type	Description	Example
port_id required	string	Port ID	`91424c08-0b26-49fb-9808-ed042292ceef`
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
publicip_id required	string	Public IP ID	`615fa9cd5cff486c9de679b3ce63e601`

Responses

Name	Description	Example

3.1.16.3 - 1.0

scpcli virtualserver server interface add static nat
--port_id <value>
--server_id <value>
--publicip_id <value>

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

Name	Type	Description	Example
port_id required	string	Port ID	`91424c08-0b26-49fb-9808-ed042292ceef`
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
publicip_id required	string	Public IP ID	`615fa9cd5cff486c9de679b3ce63e601`

Responses

Name	Description	Example

3.1.17 - Create Server Interface Private Nat

3.1.17.1 - 1.2

scpcli virtualserver server interface add private static nat
--port_id <value>
--server_id <value>
--private_nat_ip_id <value>
--private_nat_id <value>

Description

Create Server Interface Private Nat.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
port_id required	string	Port ID	`91424c08-0b26-49fb-9808-ed042292ceef`
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
private_nat_ip_id required	string	Private NAT IP ID	`1f0cb5390c40483592ddc5a282f53496`
private_nat_id required	string	Private NAT ID	`3a6c1dc6b1b24e02a444d672c2798a1c`

Responses

Name	Description	Example

3.1.17.2 - 1.1

scpcli virtualserver server interface add private static nat
--port_id <value>
--server_id <value>
--private_nat_ip_id <value>
--private_nat_id <value>

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

Name	Type	Description	Example
port_id required	string	Port ID	`91424c08-0b26-49fb-9808-ed042292ceef`
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
private_nat_ip_id required	string	Private NAT IP ID	`1f0cb5390c40483592ddc5a282f53496`
private_nat_id required	string	Private NAT ID	`3a6c1dc6b1b24e02a444d672c2798a1c`

Responses

Name	Description	Example

3.1.17.3 - 1.0

scpcli virtualserver server interface add private static nat
--port_id <value>
--server_id <value>
--private_nat_ip_id <value>
--private_nat_id <value>

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

Name	Type	Description	Example
port_id required	string	Port ID	`91424c08-0b26-49fb-9808-ed042292ceef`
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
private_nat_ip_id required	string	Private NAT IP ID	`1f0cb5390c40483592ddc5a282f53496`
private_nat_id required	string	Private NAT ID	`3a6c1dc6b1b24e02a444d672c2798a1c`

Responses

Name	Description	Example

3.1.18 - Create Server Volume

3.1.18.1 - 1.2

scpcli virtualserver server add volume
--server_id <value>
--volume_id <value>
[--delete_on_termination <value>]
[--device <value>]

Description

Attach volume that are created to server.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
volume_id required	string	Volume ID	`3f500f00-ed80-4566-a057-e31760226f9a`
delete_on_termination optional	boolean	Delete the boot volume when the server is terminated.	`False`
device optional	string	Device name such as, /dev/vda.	`/dev/vda`

Responses

Name	Description	Example
id	Volume Attachment ID	3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c
delete_on_termination	Delete the boot volume when the server is terminated.	False
device	Device name such as, /dev/vda.	/dev/vda
server_id	Server ID	2a9be312-5d4b-4bc8-b2ae-35100fa9241f
volume_id	Volume ID	3f500f00-ed80-4566-a057-e31760226f9a

3.1.18.2 - 1.1

scpcli virtualserver server add volume
--server_id <value>
--volume_id <value>
[--delete_on_termination <value>]
[--device <value>]

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

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
volume_id required	string	Volume ID	`3f500f00-ed80-4566-a057-e31760226f9a`
delete_on_termination optional	boolean	Delete the boot volume when the server is terminated.	`False`
device optional	string	Device name such as, /dev/vda.	`/dev/vda`

Responses

Name	Description	Example
id	Volume Attachment ID	3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c
delete_on_termination	Delete the boot volume when the server is terminated.	False
device	Device name such as, /dev/vda.	/dev/vda
server_id	Server ID	2a9be312-5d4b-4bc8-b2ae-35100fa9241f
volume_id	Volume ID	3f500f00-ed80-4566-a057-e31760226f9a

3.1.18.3 - 1.0

scpcli virtualserver server add volume
--server_id <value>
--volume_id <value>
[--delete_on_termination <value>]
[--device <value>]

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

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
volume_id required	string	Volume ID	`3f500f00-ed80-4566-a057-e31760226f9a`
delete_on_termination optional	boolean	Delete the boot volume when the server is terminated.	`False`
device optional	string	Device name such as, /dev/vda.	`/dev/vda`

Responses

Name	Description	Example
id	Volume Attachment ID	3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c
delete_on_termination	Delete the boot volume when the server is terminated.	False
device	Device name such as, /dev/vda.	/dev/vda
server_id	Server ID	2a9be312-5d4b-4bc8-b2ae-35100fa9241f
volume_id	Volume ID	3f500f00-ed80-4566-a057-e31760226f9a

3.1.19 - Create Sharing Image

3.1.19.1 - 1.2

scpcli virtualserver sharing image create
--image_id <value>

Description

Create Sharing Image.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

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

Responses

Name	Description	Example

3.1.19.2 - 1.1

scpcli virtualserver sharing image create
--image_id <value>

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

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

Responses

Name	Description	Example

3.1.19.3 - 1.0

scpcli virtualserver sharing image create
--image_id <value>

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

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

Responses

Name	Description	Example

3.1.20 - Create Virtual Server

3.1.20.1 - 1.2

scpcli virtualserver server create
--volumes <value>
--server_type_id <value>
--networks <value>
--name <value>
--keypair_name <value>
--image_id <value>
[--file_storage_ids <value>]
[--lock <value>]
[--max_count <value>]
[--metadata <value>]
[--partition_number <value>]
[--product_category <value>]
[--product_offering <value>]
[--security_groups <value>]
[--server_group_id <value>]
[--tags <value>]
[--user_data <value>]

Description

Create Virtual Server.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
volumes required	array	Volumes	`'{"boot_index": 0, "delete_on_termination": false, "max_iops": 10000, "max_throughput": 500, "size": 104, "source_type": "image", "type": "SSD"}'`
server_type_id required	string	Server type ID	`s1v1m2`
networks required	array	List of Network	`'{"fixed_ip": "192.169.3.2", "port_id": "91424c08-0b26-49fb-9808-ed042292ceef", "public_ip_id": "615fa9cd5cff486c9de679b3ce63e601", "subnet_id": "78b2ee3f074145c580ab6abac4821f97"}'`
name required	string	Server name	`servername`
keypair_name required	string	Keypair name	`keypairname`
image_id required	string	Image ID	`70a599e0-31e7-49b7-b260-868f441e862b`
file_storage_ids optional	array	File Storage ID list	`96d258ea-dd5d-4cca-bb3a-b6909b7e2065`
lock optional	boolean	Sets the server's lock status. When the server is locked, most user actions are not allowed.	`False`
max_count optional	integer	Maximum number of servers to launch.	`2`
metadata optional	object	User can specify custom server metadata as a set of key-value pairs.	-
partition_number optional	integer	Sets the target partition number for server creation. only usable if server group type is partition.	`1`
product_category optional	****	Product category	`compute`
product_offering optional	****	Product offering	`virtual_server`
security_groups optional	array	Security Groups	`c09c3f05-03d9-443f-b27a-40e0f973c75f`
server_group_id optional	string	Server Group ID	`616fb98f-46ca-475e-917e-2563e5a8cd19`
tags optional	array	Tags	`'{"key": "Key", "value": "Value"}'`
user_data optional	string	Script or configuration to run when the server starts. it must be Base64-encoded string and must not exceed 65535 bytes.	`IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==`

Responses

Name	Description	Example
id	Server ID	2a9be312-5d4b-4bc8-b2ae-35100fa9241f

3.1.20.2 - 1.1

scpcli virtualserver server create
--server_type_id <value>
--networks <value>
--name <value>
--keypair_name <value>
--image_id <value>
[--lock <value>]
[--max_count <value>]
[--metadata <value>]
[--partition_number <value>]
[--product_category <value>]
[--product_offering <value>]
[--security_groups <value>]
[--server_group_id <value>]
[--tags <value>]
[--user_data <value>]
[--volumes <value>]

Description

Create Virtual Server.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.1	20260531

Parameters

Name	Type	Description	Example
server_type_id required	string	Server type ID	`s1v1m2`
networks required	array	List of Network	`'{"fixed_ip": "192.169.3.2", "port_id": "91424c08-0b26-49fb-9808-ed042292ceef", "public_ip_id": "615fa9cd5cff486c9de679b3ce63e601", "subnet_id": "78b2ee3f074145c580ab6abac4821f97"}'`
name required	string	Server name	`servername`
keypair_name required	string	Keypair name	`keypairname`
image_id required	string	Image ID	`70a599e0-31e7-49b7-b260-868f441e862b`
lock optional	boolean	Sets the server's lock status. When the server is locked, most user actions are not allowed.	`False`
max_count optional	integer	Maximum number of servers to launch.	`2`
metadata optional	object	User can specify custom server metadata as a set of key-value pairs.	-
partition_number optional	integer	Sets the target partition number for server creation. only usable if server group type is partition.	`1`
product_category optional	****	Product category	`compute`
product_offering optional	****	Product offering	`virtual_server`
security_groups optional	array	Security Groups	`c09c3f05-03d9-443f-b27a-40e0f973c75f`
server_group_id optional	string	Server Group ID	`616fb98f-46ca-475e-917e-2563e5a8cd19`
tags optional	array	Tags	`'{"key": "Key", "value": "Value"}'`
user_data optional	string	Script or configuration to run when the server starts. it must be Base64-encoded string and must not exceed 65535 bytes.	`IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==`
volumes optional	array	Volumes	`'{"boot_index": 0, "delete_on_termination": false, "size": 104, "source_type": "image", "type": "SSD"}'`

Responses

Name	Description	Example
id	Server ID	2a9be312-5d4b-4bc8-b2ae-35100fa9241f

3.1.20.3 - 1.0

scpcli virtualserver server create
--server_type_id <value>
--networks <value>
--name <value>
--keypair_name <value>
--image_id <value>
[--lock <value>]
[--max_count <value>]
[--metadata <value>]
[--partition_number <value>]
[--product_category <value>]
[--product_offering <value>]
[--security_groups <value>]
[--server_group_id <value>]
[--tags <value>]
[--user_data <value>]
[--volumes <value>]

Description

Create Virtual Server.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
server_type_id required	string	Server type ID	`s1v1m2`
networks required	array	List of Network	`'{"fixed_ip": "192.169.3.2", "port_id": "91424c08-0b26-49fb-9808-ed042292ceef", "public_ip_id": "615fa9cd5cff486c9de679b3ce63e601", "subnet_id": "78b2ee3f074145c580ab6abac4821f97"}'`
name required	string	Server name	`servername`
keypair_name required	string	Keypair name	`keypairname`
image_id required	string	Image ID	`70a599e0-31e7-49b7-b260-868f441e862b`
lock optional	boolean	Sets the server's lock status. When the server is locked, most user actions are not allowed.	`False`
max_count optional	integer	Maximum number of servers to launch.	`2`
metadata optional	object	User can specify custom server metadata as a set of key-value pairs.	-
partition_number optional	integer	Sets the target partition number for server creation. only usable if server group type is partition.	`1`
product_category optional	****	Product category	`compute`
product_offering optional	****	Product offering	`virtual_server`
security_groups optional	array	Security Groups	`c09c3f05-03d9-443f-b27a-40e0f973c75f`
server_group_id optional	string	Server Group ID	`616fb98f-46ca-475e-917e-2563e5a8cd19`
tags optional	array	Tags	`'{"key": "Key", "value": "Value"}'`
user_data optional	string	Script or configuration to run when the server starts. it must be Base64-encoded string and must not exceed 65535 bytes.	`IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==`
volumes optional	array	Volumes	`'{"boot_index": 0, "delete_on_termination": false, "size": 104, "source_type": "image", "type": "SSD"}'`

Responses

Name	Description	Example
id	Server ID	2a9be312-5d4b-4bc8-b2ae-35100fa9241f

3.1.21 - Create Virtual Server Custom Image

3.1.21.1 - 1.2

scpcli virtualserver server image create
--server_id <value>
--image_name <value>

Description

Create Virtual Server Custom Image.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
image_name required	string	Image name	`imagename`

Responses

Name	Description	Example
image_id	Image ID	70a599e0-31e7-49b7-b260-868f441e862b

3.1.21.2 - 1.1

scpcli virtualserver server image create
--server_id <value>
--image_name <value>

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

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
image_name required	string	Image name	`imagename`

Responses

Name	Description	Example
image_id	Image ID	70a599e0-31e7-49b7-b260-868f441e862b

3.1.21.3 - 1.0

scpcli virtualserver server image create
--server_id <value>
--image_name <value>

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

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
image_name required	string	Image name	`imagename`

Responses

Name	Description	Example
image_id	Image ID	70a599e0-31e7-49b7-b260-868f441e862b

3.1.22 - Create Virtual Server Dump

3.1.22.1 - 1.2

scpcli virtualserver server dump create
--server_id <value>

Description

Create Virtual Server Dump.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`

Responses

Name	Description	Example

3.1.22.2 - 1.1

scpcli virtualserver server dump create
--server_id <value>

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

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`

Responses

Name	Description	Example

3.1.22.3 - 1.0

scpcli virtualserver server dump create
--server_id <value>

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

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`

Responses

Name	Description	Example

3.1.23 - Create Volume

3.1.23.1 - 1.2

scpcli virtualserver volume create
--size <value>
--name <value>
[--max_iops <value>]
[--max_throughput <value>]
[--snapshot_id <value>]
[--tags <value>]
[--volume_type <value>]

Description

Create a Volume.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
size required	integer	Volume size, in gibibytes(GiB), must be multiple of 8.	`104`
name required	string	Volume name	`volume01`
max_iops optional	integer	The number of distinct read or write operations a volume can process in a single second.	`10000`
max_throughput optional	integer	The actual amount of data (volume) transferred to or from the storage device per second.	`500`
snapshot_id optional	string	Snapshot ID used to create the volume. when specified, request volume size must be greater than or equal to the size of the snapshot.	`cceed636-1f1e-4bb0-b85c-4e5b9e0bf790`
tags optional	array	Tags	`'{"key": "Key", "value": "Value"}'`
volume_type optional	string	Sets the Volume type. if volume type is not set, the volume will be created using default type (SSD).	`SSD`

Responses

Name	Description	Example
id	Server ID	2a9be312-5d4b-4bc8-b2ae-35100fa9241f
attached_at	The time when the volume was attached to the server.
device	Device name such as, /dev/vda.	/dev/vda

3.1.23.2 - 1.1

scpcli virtualserver volume create
--size <value>
--name <value>
[--snapshot_id <value>]
[--tags <value>]
[--volume_type <value>]

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

Name	Type	Description	Example
size required	integer	Volume size, in gibibytes(GiB), must be multiple of 8.	`104`
name required	string	Volume name	`volume01`
snapshot_id optional	string	Snapshot ID used to create the volume. when specified, request volume size must be greater than or equal to the size of the snapshot.	`cceed636-1f1e-4bb0-b85c-4e5b9e0bf790`
tags optional	array	Tags	`'{"key": "Key", "value": "Value"}'`
volume_type optional	string	Sets the Volume type. if volume type is not set, the volume will be created using default type (SSD).	`SSD`

Responses

Name	Description	Example
id	Server ID	2a9be312-5d4b-4bc8-b2ae-35100fa9241f
attached_at	The time when the volume was attached to the server.
device	Device name such as, /dev/vda.	/dev/vda

3.1.23.3 - 1.0

scpcli virtualserver volume create
--size <value>
--name <value>
[--snapshot_id <value>]
[--tags <value>]
[--volume_type <value>]

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

Name	Type	Description	Example
size required	integer	Volume size, in gibibytes(GiB), must be multiple of 8.	`104`
name required	string	Volume name	`volume01`
snapshot_id optional	string	Snapshot ID used to create the volume. when specified, request volume size must be greater than or equal to the size of the snapshot.	`cceed636-1f1e-4bb0-b85c-4e5b9e0bf790`
tags optional	array	Tags	`'{"key": "Key", "value": "Value"}'`
volume_type optional	string	Sets the Volume type. if volume type is not set, the volume will be created using default type (SSD).	`SSD`

Responses

Name	Description	Example
id	Server ID	2a9be312-5d4b-4bc8-b2ae-35100fa9241f
attached_at	The time when the volume was attached to the server.
device	Device name such as, /dev/vda.	/dev/vda

3.1.24 - Delete a snapshot

3.1.24.1 - 1.2

scpcli virtualserver volume snapshot delete
--snapshot_id <value>

Description

Delete a snapshot.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

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

3.1.24.2 - 1.1

scpcli virtualserver volume snapshot delete
--snapshot_id <value>

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

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

3.1.24.3 - 1.0

scpcli virtualserver volume snapshot delete
--snapshot_id <value>

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

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

3.1.25 - Delete a volume transfer

3.1.25.1 - 1.2

scpcli virtualserver volume transfer delete
--transfer_id <value>

Description

Delete a volume transfer.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
transfer_id required	string	Volume Transfer ID	`1ac231be-823b-4a4d-8ff0-aac503a7118a`

3.1.25.2 - 1.1

scpcli virtualserver volume transfer delete
--transfer_id <value>

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

Name	Type	Description	Example
transfer_id required	string	Volume Transfer ID	`1ac231be-823b-4a4d-8ff0-aac503a7118a`

3.1.25.3 - 1.0

scpcli virtualserver volume transfer delete
--transfer_id <value>

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

Name	Type	Description	Example
transfer_id required	string	Volume Transfer ID	`1ac231be-823b-4a4d-8ff0-aac503a7118a`

3.1.26 - Delete Auto-Scaling Group

3.1.26.1 - 1.2

scpcli virtualserver auto scaling group delete
--auto_scaling_group_id <value>

Description

Delete Auto-Scaling Group.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`

3.1.26.2 - 1.1

scpcli virtualserver auto scaling group delete
--auto_scaling_group_id <value>

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

Name	Type	Description	Example
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`

3.1.26.3 - 1.0

scpcli virtualserver auto scaling group delete
--auto_scaling_group_id <value>

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

Name	Type	Description	Example
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`

3.1.27 - Delete Auto-Scaling Group Notification

3.1.27.1 - 1.2

scpcli virtualserver auto scaling group notification delete
--notification_id <value>
--auto_scaling_group_id <value>

Description

Delete Auto-Scaling Group notification.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
notification_id required	string	Auto-Scaling Group notification ID	`fa7fd191410744cd810a290c0b4d22b9`
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`

3.1.27.2 - 1.1

scpcli virtualserver auto scaling group notification delete
--notification_id <value>
--auto_scaling_group_id <value>

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

Name	Type	Description	Example
notification_id required	string	Auto-Scaling Group notification ID	`fa7fd191410744cd810a290c0b4d22b9`
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`

3.1.27.3 - 1.0

scpcli virtualserver auto scaling group notification delete
--notification_id <value>
--auto_scaling_group_id <value>

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

Name	Type	Description	Example
notification_id required	string	Auto-Scaling Group notification ID	`fa7fd191410744cd810a290c0b4d22b9`
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`

3.1.28 - Delete Auto-Scaling Group Policy

3.1.28.1 - 1.2

scpcli virtualserver auto scaling group policy delete
--policy_id <value>
--auto_scaling_group_id <value>

Description

Delete Auto-Scaling Group policy.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
policy_id required	string	Policy ID	`0761d76085f54363bab07909baf69841`
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`

3.1.28.2 - 1.1

scpcli virtualserver auto scaling group policy delete
--policy_id <value>
--auto_scaling_group_id <value>

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

Name	Type	Description	Example
policy_id required	string	Policy ID	`0761d76085f54363bab07909baf69841`
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`

3.1.28.3 - 1.0

scpcli virtualserver auto scaling group policy delete
--policy_id <value>
--auto_scaling_group_id <value>

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

Name	Type	Description	Example
policy_id required	string	Policy ID	`0761d76085f54363bab07909baf69841`
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`

3.1.29 - Delete Auto-Scaling Group Schedule

3.1.29.1 - 1.2

scpcli virtualserver auto scaling group schedule delete
--schedule_id <value>
--auto_scaling_group_id <value>

Description

Delete Auto-Scaling Group schedule.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
schedule_id required	string	Schedule ID	`43d4841abd404220af5f0904037aba71`
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`

3.1.29.2 - 1.1

scpcli virtualserver auto scaling group schedule delete
--schedule_id <value>
--auto_scaling_group_id <value>

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

Name	Type	Description	Example
schedule_id required	string	Schedule ID	`43d4841abd404220af5f0904037aba71`
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`

3.1.29.3 - 1.0

scpcli virtualserver auto scaling group schedule delete
--schedule_id <value>
--auto_scaling_group_id <value>

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

Name	Type	Description	Example
schedule_id required	string	Schedule ID	`43d4841abd404220af5f0904037aba71`
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`

3.1.30 - Delete Image

3.1.30.1 - 1.2

scpcli virtualserver image delete
--image_id <value>

Description

Delete Image.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

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

3.1.30.2 - 1.1

scpcli virtualserver image delete
--image_id <value>

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

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

3.1.30.3 - 1.0

scpcli virtualserver image delete
--image_id <value>

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

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

3.1.31 - Delete Image member

3.1.31.1 - 1.2

scpcli virtualserver image remove member
--member_id <value>
--image_id <value>

Description

Delete Image member.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
member_id required	string	Shared Image member ID	`a8f10467abfc4b87b64614ab36eb9ae4`
image_id required	string	Image ID	`70a599e0-31e7-49b7-b260-868f441e862b`

3.1.31.2 - 1.1

scpcli virtualserver image remove member
--member_id <value>
--image_id <value>

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

Name	Type	Description	Example
member_id required	string	Shared Image member ID	`a8f10467abfc4b87b64614ab36eb9ae4`
image_id required	string	Image ID	`70a599e0-31e7-49b7-b260-868f441e862b`

3.1.31.3 - 1.0

scpcli virtualserver image remove member
--member_id <value>
--image_id <value>

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

Name	Type	Description	Example
member_id required	string	Shared Image member ID	`a8f10467abfc4b87b64614ab36eb9ae4`
image_id required	string	Image ID	`70a599e0-31e7-49b7-b260-868f441e862b`

3.1.32 - Delete Keypair

3.1.32.1 - 1.2

scpcli virtualserver keypair delete
--keypair_name <value>

Description

Delete keypair.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
keypair_name required	string	Keypair name	`keypairname`

3.1.32.2 - 1.1

scpcli virtualserver keypair delete
--keypair_name <value>

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

Name	Type	Description	Example
keypair_name required	string	Keypair name	`keypairname`

3.1.32.3 - 1.0

scpcli virtualserver keypair delete
--keypair_name <value>

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

Name	Type	Description	Example
keypair_name required	string	Keypair name	`keypairname`

3.1.33 - Delete Launch Configuration

3.1.33.1 - 1.2

scpcli virtualserver launch configuration delete
--launch_configuration_id <value>

Description

Delete Launch Configuration.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
launch_configuration_id required	string	Launch Configuration ID	`b5aea5a675fc4f6b9e0fcd1288354c5f`

3.1.33.2 - 1.1

scpcli virtualserver launch configuration delete
--launch_configuration_id <value>

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

Name	Type	Description	Example
launch_configuration_id required	string	Launch Configuration ID	`b5aea5a675fc4f6b9e0fcd1288354c5f`

3.1.33.3 - 1.0

scpcli virtualserver launch configuration delete
--launch_configuration_id <value>

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

Name	Type	Description	Example
launch_configuration_id required	string	Launch Configuration ID	`b5aea5a675fc4f6b9e0fcd1288354c5f`

3.1.34 - Delete Server Group

3.1.34.1 - 1.2

scpcli virtualserver server group delete
--server_group_id <value>

Description

Delete server group

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
server_group_id required	string	Server Group ID	`616fb98f-46ca-475e-917e-2563e5a8cd19`

3.1.34.2 - 1.1

scpcli virtualserver server group delete
--server_group_id <value>

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

Name	Type	Description	Example
server_group_id required	string	Server Group ID	`616fb98f-46ca-475e-917e-2563e5a8cd19`

3.1.34.3 - 1.0

scpcli virtualserver server group delete
--server_group_id <value>

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

Name	Type	Description	Example
server_group_id required	string	Server Group ID	`616fb98f-46ca-475e-917e-2563e5a8cd19`

3.1.35 - Delete Server Interface

3.1.35.1 - 1.2

scpcli virtualserver server remove interface
--port_id <value>
--server_id <value>

Description

Delete Server Interface.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
port_id required	string	Port ID	`91424c08-0b26-49fb-9808-ed042292ceef`
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`

3.1.35.2 - 1.1

scpcli virtualserver server remove interface
--port_id <value>
--server_id <value>

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

Name	Type	Description	Example
port_id required	string	Port ID	`91424c08-0b26-49fb-9808-ed042292ceef`
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`

3.1.35.3 - 1.0

scpcli virtualserver server remove interface
--port_id <value>
--server_id <value>

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

Name	Type	Description	Example
port_id required	string	Port ID	`91424c08-0b26-49fb-9808-ed042292ceef`
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`

3.1.36 - Delete Server Interface Nat

3.1.36.1 - 1.2

scpcli virtualserver server interface remove static nat
--nat_id <value>
--port_id <value>
--server_id <value>

Description

Delete Server Interface Public Nat.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
nat_id required	string	NAT ID	`224b80106e6f41b38efe98ac9ddbf280`
port_id required	string	Port ID	`91424c08-0b26-49fb-9808-ed042292ceef`
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`

3.1.36.2 - 1.1

scpcli virtualserver server interface remove static nat
--nat_id <value>
--port_id <value>
--server_id <value>

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

Name	Type	Description	Example
nat_id required	string	NAT ID	`224b80106e6f41b38efe98ac9ddbf280`
port_id required	string	Port ID	`91424c08-0b26-49fb-9808-ed042292ceef`
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`

3.1.36.3 - 1.0

scpcli virtualserver server interface remove static nat
--nat_id <value>
--port_id <value>
--server_id <value>

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

Name	Type	Description	Example
nat_id required	string	NAT ID	`224b80106e6f41b38efe98ac9ddbf280`
port_id required	string	Port ID	`91424c08-0b26-49fb-9808-ed042292ceef`
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`

3.1.37 - Delete Server Interface Private Nat

3.1.37.1 - 1.2

scpcli virtualserver server interface remove private static nat
--nat_id <value>
--port_id <value>
--server_id <value>

Description

Delete Server Interface Private Nat.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
nat_id required	string	NAT ID	`224b80106e6f41b38efe98ac9ddbf280`
port_id required	string	Port ID	`91424c08-0b26-49fb-9808-ed042292ceef`
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`

3.1.37.2 - 1.1

scpcli virtualserver server interface remove private static nat
--nat_id <value>
--port_id <value>
--server_id <value>

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

Name	Type	Description	Example
nat_id required	string	NAT ID	`224b80106e6f41b38efe98ac9ddbf280`
port_id required	string	Port ID	`91424c08-0b26-49fb-9808-ed042292ceef`
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`

3.1.37.3 - 1.0

scpcli virtualserver server interface remove private static nat
--nat_id <value>
--port_id <value>
--server_id <value>

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

Name	Type	Description	Example
nat_id required	string	NAT ID	`224b80106e6f41b38efe98ac9ddbf280`
port_id required	string	Port ID	`91424c08-0b26-49fb-9808-ed042292ceef`
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`

3.1.38 - Delete Server Volume

3.1.38.1 - 1.2

scpcli virtualserver server remove volume
--volume_id <value>
--server_id <value>

Description

Delete Server Volume.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
volume_id required	string	Volume ID	`3f500f00-ed80-4566-a057-e31760226f9a`
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`

3.1.38.2 - 1.1

scpcli virtualserver server remove volume
--volume_id <value>
--server_id <value>

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

Name	Type	Description	Example
volume_id required	string	Volume ID	`3f500f00-ed80-4566-a057-e31760226f9a`
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`

3.1.38.3 - 1.0

scpcli virtualserver server remove volume
--volume_id <value>
--server_id <value>

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

Name	Type	Description	Example
volume_id required	string	Volume ID	`3f500f00-ed80-4566-a057-e31760226f9a`
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`

3.1.39 - Delete Virtual Server

3.1.39.1 - 1.2

scpcli virtualserver server delete
--server_id <value>

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

Parameters

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`

3.1.39.2 - 1.1

scpcli virtualserver server delete
--server_id <value>

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

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`

3.1.39.3 - 1.0

scpcli virtualserver server delete
--server_id <value>

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

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`

3.1.40 - Delete Volume

3.1.40.1 - 1.2

scpcli virtualserver volume delete
--volume_id <value>
[--cascade <value>]

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

Parameters

Name	Type	Description	Example
volume_id required	string	Volume ID	`3f500f00-ed80-4566-a057-e31760226f9a`
cascade optional	boolean	Whether to delete snapshots together	`True`

3.1.40.2 - 1.1

scpcli virtualserver volume delete
--volume_id <value>
[--cascade <value>]

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

Name	Type	Description	Example
volume_id required	string	Volume ID	`3f500f00-ed80-4566-a057-e31760226f9a`
cascade optional	boolean	Whether to delete snapshots together	`True`

3.1.40.3 - 1.0

scpcli virtualserver volume delete
--volume_id <value>
[--cascade <value>]

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

Name	Type	Description	Example
volume_id required	string	Volume ID	`3f500f00-ed80-4566-a057-e31760226f9a`
cascade optional	boolean	Whether to delete snapshots together	`True`

3.1.41 - Detach Virtual Server Security Group

3.1.41.1 - 1.0

scpcli virtualserver server remove security group
--security_group_id <value>
--server_id <value>

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

Name	Type	Description	Example
security_group_id required	string	Security Group ID	`c09c3f05-03d9-443f-b27a-40e0f973c75f`
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`

3.1.42 - Detach Volume from Virtual Server

3.1.42.1 - 1.2

scpcli virtualserver volume detach server
--server_id <value>
--volume_id <value>

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

Parameters

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
volume_id required	string	Volume ID	`3f500f00-ed80-4566-a057-e31760226f9a`

3.1.42.2 - 1.1

scpcli virtualserver volume detach server
--server_id <value>
--volume_id <value>

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

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
volume_id required	string	Volume ID	`3f500f00-ed80-4566-a057-e31760226f9a`

3.1.42.3 - 1.0

scpcli virtualserver volume detach server
--server_id <value>
--volume_id <value>

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

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
volume_id required	string	Volume ID	`3f500f00-ed80-4566-a057-e31760226f9a`

3.1.43 - Extend Volume

3.1.43.1 - 1.2

scpcli virtualserver volume resize
--volume_id <value>
--size <value>

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

Parameters

Name	Type	Description	Example
volume_id required	string	Volume ID	`3f500f00-ed80-4566-a057-e31760226f9a`
size required	integer	Volume size	`104`

3.1.43.2 - 1.1

scpcli virtualserver volume resize
--volume_id <value>
--size <value>

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

Name	Type	Description	Example
volume_id required	string	Volume ID	`3f500f00-ed80-4566-a057-e31760226f9a`
size required	integer	Volume size	`104`

3.1.43.3 - 1.0

scpcli virtualserver volume resize
--volume_id <value>
--size <value>

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

Name	Type	Description	Example
volume_id required	string	Volume ID	`3f500f00-ed80-4566-a057-e31760226f9a`
size required	integer	Volume size	`104`

3.1.44 - Get region's maximum partition size.

3.1.44.1 - 1.2

scpcli virtualserver server group maximum partition size

Description

Get region’s maximum partition size

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Responses

Name	Description	Example
partition_size

3.1.44.2 - 1.1

scpcli virtualserver server group maximum 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

Name	Description	Example
partition_size

3.1.44.3 - 1.0

scpcli virtualserver server group maximum 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

Name	Description	Example
partition_size

3.1.45 - Import Image

3.1.45.1 - 1.2

scpcli virtualserver image import
--image_id <value>
--url <value>

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

Parameters

Name	Type	Description	Example
image_id required	string	Image ID	`70a599e0-31e7-49b7-b260-868f441e862b`
url required	string	Object Storage URL for Image file (only qcow2 format allowed)	`https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2`

Responses

Name	Description	Example

3.1.45.2 - 1.1

scpcli virtualserver image import
--image_id <value>
--url <value>

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

Name	Type	Description	Example
image_id required	string	Image ID	`70a599e0-31e7-49b7-b260-868f441e862b`
url required	string	Object Storage URL for Image file (only qcow2 format allowed)	`https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2`

Responses

Name	Description	Example

3.1.45.3 - 1.0

scpcli virtualserver image import
--image_id <value>
--url <value>

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

Name	Type	Description	Example
image_id required	string	Image ID	`70a599e0-31e7-49b7-b260-868f441e862b`
url required	string	Object Storage URL for Image file (only qcow2 format allowed)	`https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2`

Responses

Name	Description	Example

3.1.46 - List Auto-Scaling Group LB Server Groups

3.1.46.1 - 1.2

scpcli virtualserver auto scaling group lb server group list
--auto_scaling_group_id <value>
[--offset <value>]
[--limit <value>]
[--sort <value>]

Description

List Auto-Scaling Group LB Server Groups.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`
offset optional	integer	Index of where to start in the list	`0`
limit optional	integer	Page size of items	`20`
sort optional	string	Comma-separated list of sort keys and optional sort directions in the form of [:]	`created_at:desc`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	LB Server Group name	lb-server-group-name
port	LB Server Group port	8080

3.1.46.2 - 1.1

scpcli virtualserver auto scaling group lb server group list
--auto_scaling_group_id <value>
[--offset <value>]
[--limit <value>]
[--sort <value>]

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

Name	Type	Description	Example
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`
offset optional	integer	Index of where to start in the list	`0`
limit optional	integer	Page size of items	`20`
sort optional	string	Comma-separated list of sort keys and optional sort directions in the form of [:]	`created_at:desc`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	LB Server Group name	lb-server-group-name
port	LB Server Group port	8080

3.1.46.3 - 1.0

scpcli virtualserver auto scaling group lb server group list
--auto_scaling_group_id <value>
[--offset <value>]
[--limit <value>]
[--sort <value>]

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

Name	Type	Description	Example
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`
offset optional	integer	Index of where to start in the list	`0`
limit optional	integer	Page size of items	`20`
sort optional	string	Comma-separated list of sort keys and optional sort directions in the form of [:]	`created_at:desc`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	LB Server Group name	lb-server-group-name
port	LB Server Group port	8080

3.1.47 - List Auto-Scaling Group Notifications

3.1.47.1 - 1.2

scpcli virtualserver auto scaling group notification list
--auto_scaling_group_id <value>
[--user_ids <value>]
[--notification_state <value>]
[--notification_event <value>]
[--offset <value>]
[--limit <value>]
[--sort <value>]

Description

List Auto-Scaling Group notifications.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`
user_ids optional	array	User ID list	`570907805e5447be84b618450ef52o0t`
notification_state optional	string	Auto-Scaling Group notification state	`ACTIVE`
notification_event optional	string	Auto-Scaling Group notification event	`SCALE_OUT`
offset optional	integer	Index of where to start in the list	`0`
limit optional	integer	Page size of items	`20`
sort optional	string	Comma-separated list of sort keys and optional sort directions in the form of [:]	`created_at:desc`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID	a8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_id	Auto-Scaling Group ID	52613bd852b04b39adcb15a8364d856d
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
notification_events	Auto-Scaling Group notification event list	[‘SCALE_OUT’, ‘SCALE_OUT_FAIL’]
notification_state	Auto-Scaling Group notification state	ACTIVE
user_email	User email	scpuser@samsung.com
user_id	User ID	570907805e5447be84b618450ef52o0t
user_name	User name	scpuser

3.1.47.2 - 1.1

scpcli virtualserver auto scaling group notification list
--auto_scaling_group_id <value>
[--user_ids <value>]
[--notification_state <value>]
[--notification_event <value>]
[--offset <value>]
[--limit <value>]
[--sort <value>]

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

Name	Type	Description	Example
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`
user_ids optional	array	User ID list	`570907805e5447be84b618450ef52o0t`
notification_state optional	string	Auto-Scaling Group notification state	`ACTIVE`
notification_event optional	string	Auto-Scaling Group notification event	`SCALE_OUT`
offset optional	integer	Index of where to start in the list	`0`
limit optional	integer	Page size of items	`20`
sort optional	string	Comma-separated list of sort keys and optional sort directions in the form of [:]	`created_at:desc`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID	a8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_id	Auto-Scaling Group ID	52613bd852b04b39adcb15a8364d856d
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
notification_events	Auto-Scaling Group notification event list	[‘SCALE_OUT’, ‘SCALE_OUT_FAIL’]
notification_state	Auto-Scaling Group notification state	ACTIVE
user_email	User email	scpuser@samsung.com
user_id	User ID	570907805e5447be84b618450ef52o0t
user_name	User name	scpuser

3.1.47.3 - 1.0

scpcli virtualserver auto scaling group notification list
--auto_scaling_group_id <value>
[--user_ids <value>]
[--notification_state <value>]
[--notification_event <value>]
[--offset <value>]
[--limit <value>]
[--sort <value>]

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

Name	Type	Description	Example
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`
user_ids optional	array	User ID list	`570907805e5447be84b618450ef52o0t`
notification_state optional	string	Auto-Scaling Group notification state	`ACTIVE`
notification_event optional	string	Auto-Scaling Group notification event	`SCALE_OUT`
offset optional	integer	Index of where to start in the list	`0`
limit optional	integer	Page size of items	`20`
sort optional	string	Comma-separated list of sort keys and optional sort directions in the form of [:]	`created_at:desc`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID	a8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_id	Auto-Scaling Group ID	52613bd852b04b39adcb15a8364d856d
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
notification_events	Auto-Scaling Group notification event list	[‘SCALE_OUT’, ‘SCALE_OUT_FAIL’]
notification_state	Auto-Scaling Group notification state	ACTIVE
user_email	User email	scpuser@samsung.com
user_id	User ID	570907805e5447be84b618450ef52o0t
user_name	User name	scpuser

3.1.48 - List Auto-Scaling Group Policies

3.1.48.1 - 1.2

scpcli virtualserver auto scaling group policy list
--auto_scaling_group_id <value>
[--name <value>]
[--metric_method <value>]
[--metric_type <value>]
[--scale_type <value>]
[--offset <value>]
[--limit <value>]
[--sort <value>]

Description

List Auto-Scaling Group policies.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`
name optional	string	Policy name	`policy-name`
metric_method optional	****	Metric method	`AVG`
metric_type optional	string	Metric type	`CPU`
scale_type optional	****	Scale type	`SCALE_OUT`
offset optional	integer	Index of where to start in the list	`0`
limit optional	integer	Page size of items	`20`
sort optional	string	Comma-separated list of sort keys and optional sort directions in the form of [:]	`created_at:desc`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID	a8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_id	Auto-Scaling Group ID	52613bd852b04b39adcb15a8364d856d
comparison_operator	Comparison operator	ge
cooldown_seconds	Cooldown seconds	300
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
evaluation_minutes	Evaluation minutes	5
metric_method	Metric method	AVG
metric_type	Metric type	CPU
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Policy name	policy-name
scale_method	Scale method	AMOUNT
scale_type	Scale type	SCALE_OUT
scale_value	Scale value	10
state	Policy state	ACTIVE
threshold	Threshold	60
threshold_unit	Threshold unit	%

3.1.48.2 - 1.1

scpcli virtualserver auto scaling group policy list
--auto_scaling_group_id <value>
[--name <value>]
[--metric_method <value>]
[--metric_type <value>]
[--scale_type <value>]
[--offset <value>]
[--limit <value>]
[--sort <value>]

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

Name	Type	Description	Example
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`
name optional	string	Policy name	`policy-name`
metric_method optional	****	Metric method	`AVG`
metric_type optional	string	Metric type	`CPU`
scale_type optional	****	Scale type	`SCALE_OUT`
offset optional	integer	Index of where to start in the list	`0`
limit optional	integer	Page size of items	`20`
sort optional	string	Comma-separated list of sort keys and optional sort directions in the form of [:]	`created_at:desc`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID	a8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_id	Auto-Scaling Group ID	52613bd852b04b39adcb15a8364d856d
comparison_operator	Comparison operator	ge
cooldown_seconds	Cooldown seconds	300
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
evaluation_minutes	Evaluation minutes	5
metric_method	Metric method	AVG
metric_type	Metric type	CPU
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Policy name	policy-name
scale_method	Scale method	AMOUNT
scale_type	Scale type	SCALE_OUT
scale_value	Scale value	10
state	Policy state	ACTIVE
threshold	Threshold	60
threshold_unit	Threshold unit	%

3.1.48.3 - 1.0

scpcli virtualserver auto scaling group policy list
--auto_scaling_group_id <value>
[--name <value>]
[--metric_method <value>]
[--metric_type <value>]
[--scale_type <value>]
[--offset <value>]
[--limit <value>]
[--sort <value>]

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

Name	Type	Description	Example
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`
name optional	string	Policy name	`policy-name`
metric_method optional	****	Metric method	`AVG`
metric_type optional	string	Metric type	`CPU`
scale_type optional	****	Scale type	`SCALE_OUT`
offset optional	integer	Index of where to start in the list	`0`
limit optional	integer	Page size of items	`20`
sort optional	string	Comma-separated list of sort keys and optional sort directions in the form of [:]	`created_at:desc`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID	a8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_id	Auto-Scaling Group ID	52613bd852b04b39adcb15a8364d856d
comparison_operator	Comparison operator	ge
cooldown_seconds	Cooldown seconds	300
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
evaluation_minutes	Evaluation minutes	5
metric_method	Metric method	AVG
metric_type	Metric type	CPU
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Policy name	policy-name
scale_method	Scale method	AMOUNT
scale_type	Scale type	SCALE_OUT
scale_value	Scale value	10
state	Policy state	ACTIVE
threshold	Threshold	60
threshold_unit	Threshold unit	%

3.1.49 - List Auto-Scaling Group Schedules

3.1.49.1 - 1.2

scpcli virtualserver auto scaling group schedule list
--auto_scaling_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--frequency <value>]

Description

Get Auto-Scaling Group schedule list.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
frequency optional	****	Frequency	`WEEKLY`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID	a8f10467abfc4b87b64614ab36eb9ae4
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
day_of_month	Day of the month	-1,1
day_of_week	Day of the week	SU,SA
description	Description	description
desired_server_count	Desired server count	1
end_date	End date	2025-01-01
frequency	Frequency	WEEKLY
hour	Hour	9
max_server_count	Max server count	2
min_server_count	Min server count	1
minute	Minute	0
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Schedule name	schedulename
start_date	Start date	2024-01-01
state	Schedule state	ACTIVE
timezone	Timezone	Asia/Seoul

3.1.49.2 - 1.1

scpcli virtualserver auto scaling group schedule list
--auto_scaling_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--frequency <value>]

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

Name	Type	Description	Example
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
frequency optional	****	Frequency	`WEEKLY`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID	a8f10467abfc4b87b64614ab36eb9ae4
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
day_of_month	Day of the month	-1,1
day_of_week	Day of the week	SU,SA
description	Description	description
desired_server_count	Desired server count	1
end_date	End date	2025-01-01
frequency	Frequency	WEEKLY
hour	Hour	9
max_server_count	Max server count	2
min_server_count	Min server count	1
minute	Minute	0
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Schedule name	schedulename
start_date	Start date	2024-01-01
state	Schedule state	ACTIVE
timezone	Timezone	Asia/Seoul

3.1.49.3 - 1.0

scpcli virtualserver auto scaling group schedule list
--auto_scaling_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--frequency <value>]

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

Name	Type	Description	Example
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
frequency optional	****	Frequency	`WEEKLY`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID	a8f10467abfc4b87b64614ab36eb9ae4
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
day_of_month	Day of the month	-1,1
day_of_week	Day of the week	SU,SA
description	Description	description
desired_server_count	Desired server count	1
end_date	End date	2025-01-01
frequency	Frequency	WEEKLY
hour	Hour	9
max_server_count	Max server count	2
min_server_count	Min server count	1
minute	Minute	0
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Schedule name	schedulename
start_date	Start date	2024-01-01
state	Schedule state	ACTIVE
timezone	Timezone	Asia/Seoul

3.1.50 - List Auto-Scaling Group Virtual Servers

3.1.50.1 - 1.2

scpcli virtualserver auto scaling group server list
--auto_scaling_group_id <value>
[--marker <value>]
[--limit <value>]
[--sort <value>]

Description

List Auto-Scaling Group Virtual Servers.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`
marker optional	string	The last item's ID from previous request	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
limit optional	integer	Page size of items	`20`
sort optional	string	Comma-separated list of sort keys and optional sort directions in the form of [:]	`created_at:desc`

Responses

Name	Description	Example
id	Server ID	2a9be312-5d4b-4bc8-b2ae-35100fa9241f
account_id	Account ID	a8f10467abfc4b87b64614ab36eb9ae4
addresses	Addresses
auto_scaling_group_id	Auto-Scaling Group ID	52613bd852b04b39adcb15a8364d856d
created_at	Created at
created_by	Created by	97e6b22c9a4143789ca522df7457a32f
disk_config	Disk config	MANUAL
image_id	Image ID	70a599e0-31e7-49b7-b260-868f441e862b
is_asg_virtual_server_healthy	Health state of ASG Virtual Server	True
is_lb_healthy	LB Health State of ASG Virtual Server	True
is_marketplace	Is Marketplace	False
keypair_name	Keypair name	keypairname
launch_configuration_id	Launch Configuration ID	b5aea5a675fc4f6b9e0fcd1288354c5f
lb_linked_state	Load Balancer linked state	ATTACHED
locked	Locked	False
metadata	Metadata
modified_at	Modified at
name	Server name	servername
partition_number	Partition number	1
planned_compute_os_type	Planned Compute OS type	windows
product_category	Product category	compute
product_offering	Product offering	virtual_server
security_groups	Security Groups
server_group_id	Server Group ID	616fb98f-46ca-475e-917e-2563e5a8cd19
server_type	Server type
state	Server state	ACTIVE
volumes	Volumes
vpc_id	VPC ID	cc976b621087484ea5fd527f4b78708b

3.1.50.2 - 1.1

scpcli virtualserver auto scaling group server list
--auto_scaling_group_id <value>
[--marker <value>]
[--limit <value>]
[--sort <value>]

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

Name	Type	Description	Example
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`
marker optional	string	The last item's ID from previous request	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
limit optional	integer	Page size of items	`20`
sort optional	string	Comma-separated list of sort keys and optional sort directions in the form of [:]	`created_at:desc`

Responses

Name	Description	Example
id	Server ID	2a9be312-5d4b-4bc8-b2ae-35100fa9241f
account_id	Account ID	a8f10467abfc4b87b64614ab36eb9ae4
addresses	Addresses
auto_scaling_group_id	Auto-Scaling Group ID	52613bd852b04b39adcb15a8364d856d
created_at	Created at
created_by	Created by	97e6b22c9a4143789ca522df7457a32f
disk_config	Disk config	MANUAL
image_id	Image ID	70a599e0-31e7-49b7-b260-868f441e862b
is_marketplace	Is Marketplace	False
keypair_name	Keypair name	keypairname
launch_configuration_id	Launch Configuration ID	b5aea5a675fc4f6b9e0fcd1288354c5f
lb_linked_state	Load Balancer linked state	ATTACHED
locked	Locked	False
metadata	Metadata
modified_at	Modified at
name	Server name	servername
partition_number	Partition number	1
planned_compute_os_type	Planned Compute OS type	windows
product_category	Product category	compute
product_offering	Product offering	virtual_server
security_groups	Security Groups
server_group_id	Server Group ID	616fb98f-46ca-475e-917e-2563e5a8cd19
server_type	Server type
state	Server state	ACTIVE
volumes	Volumes
vpc_id	VPC ID	cc976b621087484ea5fd527f4b78708b

3.1.50.3 - 1.0

scpcli virtualserver auto scaling group server list
--auto_scaling_group_id <value>
[--marker <value>]
[--limit <value>]
[--sort <value>]

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

Name	Type	Description	Example
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`
marker optional	string	The last item's ID from previous request	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
limit optional	integer	Page size of items	`20`
sort optional	string	Comma-separated list of sort keys and optional sort directions in the form of [:]	`created_at:desc`

Responses

Name	Description	Example
id	Server ID	2a9be312-5d4b-4bc8-b2ae-35100fa9241f
account_id	Account ID	a8f10467abfc4b87b64614ab36eb9ae4
addresses	Addresses
auto_scaling_group_id	Auto-Scaling Group ID	52613bd852b04b39adcb15a8364d856d
created_at	Created at
created_by	Created by	97e6b22c9a4143789ca522df7457a32f
disk_config	Disk config	MANUAL
image_id	Image ID	70a599e0-31e7-49b7-b260-868f441e862b
is_marketplace	Is Marketplace	False
keypair_name	Keypair name	keypairname
launch_configuration_id	Launch Configuration ID	b5aea5a675fc4f6b9e0fcd1288354c5f
lb_linked_state	Load Balancer linked state	ATTACHED
locked	Locked	False
metadata	Metadata
modified_at	Modified at
name	Server name	servername
partition_number	Partition number	1
planned_compute_os_type	Planned Compute OS type	windows
product_category	Product category	compute
product_offering	Product offering	virtual_server
security_groups	Security Groups
server_group_id	Server Group ID	616fb98f-46ca-475e-917e-2563e5a8cd19
server_type	Server type
state	Server state	ACTIVE
volumes	Volumes
vpc_id	VPC ID	cc976b621087484ea5fd527f4b78708b

3.1.51 - List Auto-Scaling Groups

3.1.51.1 - 1.2

scpcli virtualserver auto scaling group list
[--name <value>]
[--state <value>]
[--launch_configuration_id <value>]
[--launch_configuration_name <value>]
[--lb_server_group_id <value>]
[--security_group_id <value>]
[--subnet_id <value>]
[--vpc_id <value>]
[--created_by <value>]
[--offset <value>]
[--limit <value>]
[--sort <value>]
[--long]

Description

List Auto-Scaling Groups.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
name optional	string	Auto-Scaling Group name	`auto-scaling-group-name`
state optional	string	Auto-Scaling Group state	`IN_SERVICE`
launch_configuration_id optional	string	Launch Configuration ID	`b5aea5a675fc4f6b9e0fcd1288354c5f`
launch_configuration_name optional	string	Launch Configuration name	`launch-configuration-name`
lb_server_group_id optional	string	LB Server Group ID	`d06e87d3-ca9a-461b-8e88-077a542a7335`
security_group_id optional	string	Security Group ID	`c09c3f05-03d9-443f-b27a-40e0f973c75f`
subnet_id optional	string	Subnet ID	`78b2ee3f074145c580ab6abac4821f97`
vpc_id optional	string	VPC ID	`cc976b621087484ea5fd527f4b78708b`
created_by optional	string	Created by	`97e6b22c9a4143789ca522df7457a32f`
offset optional	integer	Index of where to start in the list	`0`
limit optional	integer	Page size of items	`20`
sort optional	string	Comma-separated list of sort keys and optional sort directions in the form of [:]	`created_at:desc`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID Requires --long option	a8f10467abfc4b87b64614ab36eb9ae4
created_at	Created At Requires --long option	2024-05-17T00:23:17Z
created_by	Created By Requires --long option	90dddfc2b1e04edba54ba2b41539a9ac
desired_server_count	Desired server count	1
desired_server_count_editable	Desired server count editable Requires --long option	True
drain_enabled	Drain enabled Requires --long option	True
drain_timeout	Drain timeout Requires --long option	300
launch_configuration_id	Launch Configuration ID Requires --long option	b5aea5a675fc4f6b9e0fcd1288354c5f
launch_configuration_name	Launch Configuration name	launch-configuration-name
lb_server_groups	LB Server Group list Requires --long option
max_server_count	Max server count	2
min_server_count	Min server count	1
modified_at	Modified At Requires --long option	2024-05-17T00:23:17Z
modified_by	Modified By Requires --long option	90dddfc2b1e04edba54ba2b41539a9ac
name	Auto-Scaling Group name	auto-scaling-group-name
security_group_ids	Security Group ID list Requires --long option	[‘c09c3f05-03d9-443f-b27a-40e0f973c75f’]
server_name_prefix	Server name prefix Requires --long option	server-name-prefix
state	Auto-Scaling Group state	IN_SERVICE
state_check_delay_time	The delay time between ASG VM creation and state check operation Requires --long option	300
subnet_ids	Subnet ID list Requires --long option
use_lb_state_check	Whether LB state check operates or not Requires --long option	True
vpc_id	VPC ID Requires --long option	cc976b621087484ea5fd527f4b78708b

3.1.51.2 - 1.1

scpcli virtualserver auto scaling group list
[--name <value>]
[--state <value>]
[--launch_configuration_id <value>]
[--launch_configuration_name <value>]
[--lb_server_group_id <value>]
[--security_group_id <value>]
[--subnet_id <value>]
[--vpc_id <value>]
[--created_by <value>]
[--offset <value>]
[--limit <value>]
[--sort <value>]
[--long]

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

Name	Type	Description	Example
name optional	string	Auto-Scaling Group name	`auto-scaling-group-name`
state optional	string	Auto-Scaling Group state	`IN_SERVICE`
launch_configuration_id optional	string	Launch Configuration ID	`b5aea5a675fc4f6b9e0fcd1288354c5f`
launch_configuration_name optional	string	Launch Configuration name	`launch-configuration-name`
lb_server_group_id optional	string	LB Server Group ID	`d06e87d3-ca9a-461b-8e88-077a542a7335`
security_group_id optional	string	Security Group ID	`c09c3f05-03d9-443f-b27a-40e0f973c75f`
subnet_id optional	string	Subnet ID	`78b2ee3f074145c580ab6abac4821f97`
vpc_id optional	string	VPC ID	`cc976b621087484ea5fd527f4b78708b`
created_by optional	string	Created by	`97e6b22c9a4143789ca522df7457a32f`
offset optional	integer	Index of where to start in the list	`0`
limit optional	integer	Page size of items	`20`
sort optional	string	Comma-separated list of sort keys and optional sort directions in the form of [:]	`created_at:desc`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID Requires --long option	a8f10467abfc4b87b64614ab36eb9ae4
created_at	Created At Requires --long option	2024-05-17T00:23:17Z
created_by	Created By Requires --long option	90dddfc2b1e04edba54ba2b41539a9ac
desired_server_count	Desired server count	1
desired_server_count_editable	Desired server count editable Requires --long option	True
drain_enabled	Drain enabled Requires --long option	True
drain_timeout	Drain timeout Requires --long option	300
launch_configuration_id	Launch Configuration ID Requires --long option	b5aea5a675fc4f6b9e0fcd1288354c5f
launch_configuration_name	Launch Configuration name	launch-configuration-name
lb_server_groups	LB Server Group list Requires --long option
max_server_count	Max server count	2
min_server_count	Min server count	1
modified_at	Modified At Requires --long option	2024-05-17T00:23:17Z
modified_by	Modified By Requires --long option	90dddfc2b1e04edba54ba2b41539a9ac
name	Auto-Scaling Group name	auto-scaling-group-name
security_group_ids	Security Group ID list Requires --long option	[‘c09c3f05-03d9-443f-b27a-40e0f973c75f’]
server_name_prefix	Server name prefix Requires --long option	server-name-prefix
state	Auto-Scaling Group state	IN_SERVICE
subnet_ids	Subnet ID list Requires --long option
vpc_id	VPC ID Requires --long option	cc976b621087484ea5fd527f4b78708b

3.1.51.3 - 1.0

scpcli virtualserver auto scaling group list
[--name <value>]
[--state <value>]
[--launch_configuration_id <value>]
[--launch_configuration_name <value>]
[--lb_server_group_id <value>]
[--security_group_id <value>]
[--subnet_id <value>]
[--vpc_id <value>]
[--created_by <value>]
[--offset <value>]
[--limit <value>]
[--sort <value>]
[--long]

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

Name	Type	Description	Example
name optional	string	Auto-Scaling Group name	`auto-scaling-group-name`
state optional	string	Auto-Scaling Group state	`IN_SERVICE`
launch_configuration_id optional	string	Launch Configuration ID	`b5aea5a675fc4f6b9e0fcd1288354c5f`
launch_configuration_name optional	string	Launch Configuration name	`launch-configuration-name`
lb_server_group_id optional	string	LB Server Group ID	`d06e87d3-ca9a-461b-8e88-077a542a7335`
security_group_id optional	string	Security Group ID	`c09c3f05-03d9-443f-b27a-40e0f973c75f`
subnet_id optional	string	Subnet ID	`78b2ee3f074145c580ab6abac4821f97`
vpc_id optional	string	VPC ID	`cc976b621087484ea5fd527f4b78708b`
created_by optional	string	Created by	`97e6b22c9a4143789ca522df7457a32f`
offset optional	integer	Index of where to start in the list	`0`
limit optional	integer	Page size of items	`20`
sort optional	string	Comma-separated list of sort keys and optional sort directions in the form of [:]	`created_at:desc`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID Requires --long option	a8f10467abfc4b87b64614ab36eb9ae4
created_at	Created At Requires --long option	2024-05-17T00:23:17Z
created_by	Created By Requires --long option	90dddfc2b1e04edba54ba2b41539a9ac
desired_server_count	Desired server count	1
desired_server_count_editable	Desired server count editable Requires --long option	True
drain_enabled	Drain enabled Requires --long option	True
drain_timeout	Drain timeout Requires --long option	300
launch_configuration_id	Launch Configuration ID Requires --long option	b5aea5a675fc4f6b9e0fcd1288354c5f
launch_configuration_name	Launch Configuration name	launch-configuration-name
lb_server_groups	LB Server Group list Requires --long option
max_server_count	Max server count	2
min_server_count	Min server count	1
modified_at	Modified At Requires --long option	2024-05-17T00:23:17Z
modified_by	Modified By Requires --long option	90dddfc2b1e04edba54ba2b41539a9ac
name	Auto-Scaling Group name	auto-scaling-group-name
security_group_ids	Security Group ID list Requires --long option	[‘c09c3f05-03d9-443f-b27a-40e0f973c75f’]
server_name_prefix	Server name prefix Requires --long option	server-name-prefix
state	Auto-Scaling Group state	IN_SERVICE
subnet_ids	Subnet ID list Requires --long option
vpc_id	VPC ID Requires --long option	cc976b621087484ea5fd527f4b78708b

3.1.52 - List Default Configs

3.1.52.1 - 1.2

scpcli virtualserver default config list
[--name <value>]
[--category <value>]

Description

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

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
name optional	string	Name	`key`
category optional	string	Category	`AUTO_SCALING_GROUP`

Responses

Name	Description	Example
configs	Configs	(‘key’: ‘value’}
count	count	20

3.1.52.2 - 1.1

scpcli virtualserver default config list
[--name <value>]
[--category <value>]

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

Name	Type	Description	Example
name optional	string	Name	`key`
category optional	string	Category	`AUTO_SCALING_GROUP`

Responses

Name	Description	Example
configs	Configs	(‘key’: ‘value’}
count	count	20

3.1.52.3 - 1.0

scpcli virtualserver default config list
[--name <value>]
[--category <value>]

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

Name	Type	Description	Example
name optional	string	Name	`key`
category optional	string	Category	`AUTO_SCALING_GROUP`

Responses

Name	Description	Example
configs	Configs	(‘key’: ‘value’}
count	count	20

3.1.53 - List Image members

3.1.53.1 - 1.2

scpcli virtualserver image member list
--image_id <value>

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

Parameters

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

Responses

Name	Description	Example
created_at	Created at	2025-07-22T09:00:00Z
image_id	Image ID	70a599e0-31e7-49b7-b260-868f441e862b
member_id	Shared Image member ID	a8f10467abfc4b87b64614ab36eb9ae4
status	Status of this Image member. Value of one of pending, accepted, rejected.	pending
updated_at	Updated at	2025-07-26T12:00:00Z

3.1.53.2 - 1.1

scpcli virtualserver image member list
--image_id <value>

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

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

Responses

Name	Description	Example
created_at	Created at	2025-07-22T09:00:00Z
image_id	Image ID	70a599e0-31e7-49b7-b260-868f441e862b
member_id	Shared Image member ID	a8f10467abfc4b87b64614ab36eb9ae4
status	Status of this Image member. Value of one of pending, accepted, rejected.	pending
updated_at	Updated at	2025-07-26T12:00:00Z

3.1.53.3 - 1.0

scpcli virtualserver image member list
--image_id <value>

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

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

Responses

Name	Description	Example
created_at	Created at	2025-07-22T09:00:00Z
image_id	Image ID	70a599e0-31e7-49b7-b260-868f441e862b
member_id	Shared Image member ID	a8f10467abfc4b87b64614ab36eb9ae4
status	Status of this Image member. Value of one of pending, accepted, rejected.	pending
updated_at	Updated at	2025-07-26T12:00:00Z

3.1.54 - List Images

3.1.54.1 - 1.2

scpcli virtualserver image list
[--limit <value>]
[--marker <value>]
[--scp_image_type <value>]
[--scp_original_image_type <value>]
[--name <value>]
[--os_distro <value>]
[--status <value>]
[--visibility <value>]
[--sort <value>]
[--long]

Description

List Images.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
limit optional	integer	Page size of items	`20`
marker optional	string	The last item's ID from previous request	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
scp_image_type optional	string	Image type	`custom`
scp_original_image_type optional	string	Original Image type	`standard`
name optional	string	Image name	`imagename`
os_distro optional	string	OS distribution of the image to be uploaded	`alma`
status optional	string	Image status	`active`
visibility optional	****	Indicates access permissions for the Image. Private: Can be used only within the Account, Shared: Can be shared between Accounts	`private`
sort optional	string	Comma-separated list of sort keys and optional sort directions in the form of [:]	`created_at:desc`

Responses

Name	Description	Example
id	Image ID	70a599e0-31e7-49b7-b260-868f441e862b
checksum	MD5 hash of the entire image data. and this field could be used to verify the integrity of image. Requires --long option	7538e0fcb56e0e272cfd89eb384d6613
container_format	Container format Requires --long option	bare
created_at	Created at	2025-07-22T09:00:00Z
disk_format	Disk format Requires --long option	qcow2
file	The URL for the virtual server image file Requires --long option	/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file
min_disk	Minimum disk capacity (GB) of the Image to be created Requires --long option	100
min_ram	Minimum RAM capacity (GB) of the Image to be created Requires --long option	0
name	Image name	imagename
os_distro	OS distribution of the image to be uploaded	alma
os_hash_algo	OS hash algorithm used to verify image integrity Requires --long option	sha512
os_hash_value	The actual digest of the image binary, calculated with the algorithm indicated by os_hash_algo. The value is presented as a hexadecimal string. Requires --long option	c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99
os_hidden	Whether the image is hidden Requires --long option	False
owner	Owner account ID Requires --long option	a8f10467abfc4b87b64614ab36eb9ae4
owner_account_name	Owner account name Requires --long option	AccountName
owner_user_name	Owner user name Requires --long option	user@samsung.com
protected	whether Image deletion is prohibited Requires --long option	False
root_device_name	Root device name Requires --long option	/dev/vda
scp_gpu_driver	K8s GPU Image driver version Requires --long option	535.183.06
scp_image_type	Image type Requires --long option	custom
scp_k8s_version	K8S version Requires --long option	v1.28.7
scp_original_image_type	Original Image type Requires --long option	standard
scp_os_build_version	OS build version Requires --long option	20250101
scp_os_version	OS version Requires --long option	8.8
size	Image size Requires --long option	2429747200
status	Image status Requires --long option	active
updated_at	Updated at Requires --long option	2025-07-26T12:00:00Z
url	Object Storage URL for Image file (only qcow2 format allowed) Requires --long option	https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2
virtual_size	Virtual size Requires --long option	17179869184
visibility	Indicates access permissions for the Image. Private: Can be used only within the Account, Shared: Can be shared between Accounts	private
volumes	Volumes Requires --long option	[{“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}]

3.1.54.2 - 1.1

scpcli virtualserver image list
[--limit <value>]
[--marker <value>]
[--scp_image_type <value>]
[--scp_original_image_type <value>]
[--name <value>]
[--os_distro <value>]
[--status <value>]
[--visibility <value>]
[--sort <value>]
[--long]

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

Name	Type	Description	Example
limit optional	integer	Page size of items	`20`
marker optional	string	The last item's ID from previous request	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
scp_image_type optional	string	Image type	`custom`
scp_original_image_type optional	string	Original Image type	`standard`
name optional	string	Image name	`imagename`
os_distro optional	string	OS distribution of the image to be uploaded	`alma`
status optional	string	Image status	`active`
visibility optional	****	Indicates access permissions for the Image. Private: Can be used only within the Account, Shared: Can be shared between Accounts	`private`
sort optional	string	Comma-separated list of sort keys and optional sort directions in the form of [:]	`created_at:desc`

Responses

Name	Description	Example
id	Image ID	70a599e0-31e7-49b7-b260-868f441e862b
checksum	MD5 hash of the entire image data. and this field could be used to verify the integrity of image. Requires --long option	7538e0fcb56e0e272cfd89eb384d6613
container_format	Container format Requires --long option	bare
created_at	Created at	2025-07-22T09:00:00Z
disk_format	Disk format Requires --long option	qcow2
file	The URL for the virtual server image file Requires --long option	/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file
min_disk	Minimum disk capacity (GB) of the Image to be created Requires --long option	100
min_ram	Minimum RAM capacity (GB) of the Image to be created Requires --long option	0
name	Image name	imagename
os_distro	OS distribution of the image to be uploaded	alma
os_hash_algo	OS hash algorithm used to verify image integrity Requires --long option	sha512
os_hash_value	The actual digest of the image binary, calculated with the algorithm indicated by os_hash_algo. The value is presented as a hexadecimal string. Requires --long option	c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99
os_hidden	Whether the image is hidden Requires --long option	False
owner	Owner account ID Requires --long option	a8f10467abfc4b87b64614ab36eb9ae4
owner_account_name	Owner account name Requires --long option	AccountName
owner_user_name	Owner user name Requires --long option	user@samsung.com
protected	whether Image deletion is prohibited Requires --long option	False
root_device_name	Root device name Requires --long option	/dev/vda
scp_image_type	Image type Requires --long option	custom
scp_k8s_version	K8S version Requires --long option	v1.28.7
scp_original_image_type	Original Image type Requires --long option	standard
scp_os_build_version	OS build version Requires --long option	20250101
scp_os_version	OS version Requires --long option	8.8
size	Image size Requires --long option	2429747200
status	Image status Requires --long option	active
updated_at	Updated at Requires --long option	2025-07-26T12:00:00Z
url	Object Storage URL for Image file (only qcow2 format allowed) Requires --long option	https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2
virtual_size	Virtual size Requires --long option	17179869184
visibility	Indicates access permissions for the Image. Private: Can be used only within the Account, Shared: Can be shared between Accounts	private
volumes	Volumes Requires --long option	[{“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}]

3.1.54.3 - 1.0

scpcli virtualserver image list
[--limit <value>]
[--marker <value>]
[--scp_image_type <value>]
[--scp_original_image_type <value>]
[--name <value>]
[--os_distro <value>]
[--status <value>]
[--visibility <value>]
[--sort <value>]
[--long]

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

Name	Type	Description	Example
limit optional	integer	Page size of items	`20`
marker optional	string	The last item's ID from previous request	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
scp_image_type optional	string	Image type	`custom`
scp_original_image_type optional	string	Original Image type	`standard`
name optional	string	Image name	`imagename`
os_distro optional	string	OS distribution of the image to be uploaded	`alma`
status optional	string	Image status	`active`
visibility optional	****	Indicates access permissions for the Image. Private: Can be used only within the Account, Shared: Can be shared between Accounts	`private`
sort optional	string	Comma-separated list of sort keys and optional sort directions in the form of [:]	`created_at:desc`

Responses

Name	Description	Example
id	Image ID	70a599e0-31e7-49b7-b260-868f441e862b
checksum	MD5 hash of the entire image data. and this field could be used to verify the integrity of image. Requires --long option	7538e0fcb56e0e272cfd89eb384d6613
container_format	Container format Requires --long option	bare
created_at	Created at	2025-07-22T09:00:00Z
disk_format	Disk format Requires --long option	qcow2
file	The URL for the virtual server image file Requires --long option	/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file
min_disk	Minimum disk capacity (GB) of the Image to be created Requires --long option	100
min_ram	Minimum RAM capacity (GB) of the Image to be created Requires --long option	0
name	Image name	imagename
os_distro	OS distribution of the image to be uploaded	alma
os_hash_algo	OS hash algorithm used to verify image integrity Requires --long option	sha512
os_hash_value	The actual digest of the image binary, calculated with the algorithm indicated by os_hash_algo. The value is presented as a hexadecimal string. Requires --long option	c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99
os_hidden	Whether the image is hidden Requires --long option	False
owner	Owner account ID Requires --long option	a8f10467abfc4b87b64614ab36eb9ae4
owner_account_name	Owner account name Requires --long option	AccountName
owner_user_name	Owner user name Requires --long option	user@samsung.com
protected	whether Image deletion is prohibited Requires --long option	False
root_device_name	Root device name Requires --long option	/dev/vda
scp_image_type	Image type Requires --long option	custom
scp_k8s_version	K8S version Requires --long option	v1.28.7
scp_original_image_type	Original Image type Requires --long option	standard
scp_os_build_version	OS build version Requires --long option	20250101
scp_os_version	OS version Requires --long option	8.8
size	Image size Requires --long option	2429747200
status	Image status Requires --long option	active
updated_at	Updated at Requires --long option	2025-07-26T12:00:00Z
url	Object Storage URL for Image file (only qcow2 format allowed) Requires --long option	https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2
virtual_size	Virtual size Requires --long option	17179869184
visibility	Indicates access permissions for the Image. Private: Can be used only within the Account, Shared: Can be shared between Accounts	private
volumes	Volumes Requires --long option	[{“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}]

3.1.55 - List Keypairs

3.1.55.1 - 1.2

scpcli virtualserver keypair list
[--limit <value>]
[--marker <value>]
[--long]

Description

Get keypair list.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
limit optional	integer	Page size of items	`20`
marker optional	string	The last item's ID from previous request	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`

Responses

Name	Description	Example
fingerprint	Fingerprint	7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd
name	Keypair name	keypairname
public_key	Public Key Requires --long option	ssh-rsa fakeKey Generated-by-SCP
type	Keypair type	ssh

3.1.55.2 - 1.1

scpcli virtualserver keypair list
[--limit <value>]
[--marker <value>]
[--long]

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

Name	Type	Description	Example
limit optional	integer	Page size of items	`20`
marker optional	string	The last item's ID from previous request	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`

Responses

Name	Description	Example
fingerprint	Fingerprint	7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd
name	Keypair name	keypairname
public_key	Public Key Requires --long option	ssh-rsa fakeKey Generated-by-SCP
type	Keypair type	ssh

3.1.55.3 - 1.0

scpcli virtualserver keypair list
[--limit <value>]
[--marker <value>]
[--long]

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

Name	Type	Description	Example
limit optional	integer	Page size of items	`20`
marker optional	string	The last item's ID from previous request	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`

Responses

Name	Description	Example
fingerprint	Fingerprint	7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd
name	Keypair name	keypairname
public_key	Public Key Requires --long option	ssh-rsa fakeKey Generated-by-SCP
type	Keypair type	ssh

3.1.56 - List Launch Configurations

3.1.56.1 - 1.2

scpcli virtualserver launch configuration list
[--name <value>]
[--image_id <value>]
[--offset <value>]
[--limit <value>]
[--sort <value>]
[--long]

Description

List Launch Configurations.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
name optional	string	Launch Configuration name	`launch-configuration-name`
image_id optional	string	Image ID	`70a599e0-31e7-49b7-b260-868f441e862b`
offset optional	integer	Index of where to start in the list	-
limit optional	integer	Page size of items	-
sort optional	string	Comma-separated list of sort keys and optional sort directions in the form of [:]	-

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID Requires --long option	a8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_count	Number of Auto-Scaling Group attached to Launch Configuration	1
boot_disk_size	Size of default volume Requires --long option	104
created_at	Created At Requires --long option	2024-05-17T00:23:17Z
created_by	Created By Requires --long option	90dddfc2b1e04edba54ba2b41539a9ac
extra_disk_size	Size of additional volume Requires --long option	104
file_storage_ids	File Storage ID list Requires --long option
image_id	Image ID Requires --long option	70a599e0-31e7-49b7-b260-868f441e862b
image_name	Image name	imagename
keypair_name	Keypair name Requires --long option	keypairname
modified_at	Modified At Requires --long option	2024-05-17T00:23:17Z
modified_by	Modified By Requires --long option	90dddfc2b1e04edba54ba2b41539a9ac
name	Launch Configuration name	launch-configuration-name
public_key	Public Key Requires --long option	ssh-rsa fakeKey Generated-by-SCP
server_type_id	Server type ID	s1v1m2
state	Launch Configuration state Requires --long option	ACTIVE
user_data	A script that runs at the start of a server on Auto-Scaling Group that will use Launch Configuration.It must be Base64-encoded string and must not exceed 45,000 bytes. Requires --long option	IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==
volumes	Volumes

3.1.56.2 - 1.1

scpcli virtualserver launch configuration list
[--name <value>]
[--image_id <value>]
[--offset <value>]
[--limit <value>]
[--sort <value>]
[--long]

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

Name	Type	Description	Example
name optional	string	Launch Configuration name	`launch-configuration-name`
image_id optional	string	Image ID	`70a599e0-31e7-49b7-b260-868f441e862b`
offset optional	integer	Index of where to start in the list	-
limit optional	integer	Page size of items	-
sort optional	string	Comma-separated list of sort keys and optional sort directions in the form of [:]	-

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID Requires --long option	a8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_count	Number of Auto-Scaling Group attached to Launch Configuration	1
boot_disk_size	Size of default volume Requires --long option	104
created_at	Created At Requires --long option	2024-05-17T00:23:17Z
created_by	Created By Requires --long option	90dddfc2b1e04edba54ba2b41539a9ac
extra_disk_size	Size of additional volume Requires --long option	104
image_id	Image ID Requires --long option	70a599e0-31e7-49b7-b260-868f441e862b
image_name	Image name	imagename
keypair_name	Keypair name Requires --long option	keypairname
modified_at	Modified At Requires --long option	2024-05-17T00:23:17Z
modified_by	Modified By Requires --long option	90dddfc2b1e04edba54ba2b41539a9ac
name	Launch Configuration name	launch-configuration-name
public_key	Public Key Requires --long option	ssh-rsa fakeKey Generated-by-SCP
server_type_id	Server type ID	s1v1m2
state	Launch Configuration state Requires --long option	ACTIVE
user_data	A script that runs at the start of a server on Auto-Scaling Group that will use Launch Configuration.It must be Base64-encoded string and must not exceed 45,000 bytes. Requires --long option	IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==
volumes	Volumes

3.1.56.3 - 1.0

scpcli virtualserver launch configuration list
[--name <value>]
[--image_id <value>]
[--offset <value>]
[--limit <value>]
[--sort <value>]
[--long]

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

Name	Type	Description	Example
name optional	string	Launch Configuration name	`launch-configuration-name`
image_id optional	string	Image ID	`70a599e0-31e7-49b7-b260-868f441e862b`
offset optional	integer	Index of where to start in the list	-
limit optional	integer	Page size of items	-
sort optional	string	Comma-separated list of sort keys and optional sort directions in the form of [:]	-

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID Requires --long option	a8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_count	Number of Auto-Scaling Group attached to Launch Configuration	1
boot_disk_size	Size of default volume Requires --long option	104
created_at	Created At Requires --long option	2024-05-17T00:23:17Z
created_by	Created By Requires --long option	90dddfc2b1e04edba54ba2b41539a9ac
extra_disk_size	Size of additional volume Requires --long option	104
image_id	Image ID Requires --long option	70a599e0-31e7-49b7-b260-868f441e862b
image_name	Image name	imagename
keypair_name	Keypair name Requires --long option	keypairname
modified_at	Modified At Requires --long option	2024-05-17T00:23:17Z
modified_by	Modified By Requires --long option	90dddfc2b1e04edba54ba2b41539a9ac
name	Launch Configuration name	launch-configuration-name
public_key	Public Key Requires --long option	ssh-rsa fakeKey Generated-by-SCP
server_type_id	Server type ID	s1v1m2
state	Launch Configuration state Requires --long option	ACTIVE
user_data	A script that runs at the start of a server on Auto-Scaling Group that will use Launch Configuration.It must be Base64-encoded string and must not exceed 45,000 bytes. Requires --long option	IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==
volumes	Volumes

3.1.57 - List pending Images

3.1.57.1 - 1.2

scpcli virtualserver image pending list
[--scp_image_type <value>]
[--scp_original_image_type <value>]
[--long]

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

Parameters

Name	Type	Description	Example
scp_image_type optional	string	Image type	`custom`
scp_original_image_type optional	string	Original Image type	`standard`

Responses

Name	Description	Example
id	Image ID	70a599e0-31e7-49b7-b260-868f441e862b
checksum	MD5 hash of the entire image data. and this field could be used to verify the integrity of image. Requires --long option	7538e0fcb56e0e272cfd89eb384d6613
container_format	Container format Requires --long option	bare
created_at	Created at	2025-07-22T09:00:00Z
disk_format	Disk format Requires --long option	qcow2
file	The URL for the virtual server image file Requires --long option	/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file
min_disk	Minimum disk capacity (GB) of the Image to be created Requires --long option	100
min_ram	Minimum RAM capacity (GB) of the Image to be created Requires --long option	0
name	Image name	imagename
os_distro	OS distribution of the image to be uploaded	alma
os_hash_algo	OS hash algorithm used to verify image integrity Requires --long option	sha512
os_hash_value	The actual digest of the image binary, calculated with the algorithm indicated by os_hash_algo. The value is presented as a hexadecimal string. Requires --long option	c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99
os_hidden	Whether the image is hidden Requires --long option	False
owner	Owner account ID Requires --long option	a8f10467abfc4b87b64614ab36eb9ae4
owner_account_name	Owner account name Requires --long option	AccountName
owner_user_name	Owner user name Requires --long option	user@samsung.com
protected	whether Image deletion is prohibited Requires --long option	False
root_device_name	Root device name Requires --long option	/dev/vda
scp_gpu_driver	K8s GPU Image driver version Requires --long option	535.183.06
scp_image_type	Image type Requires --long option	custom
scp_k8s_version	K8S version Requires --long option	v1.28.7
scp_original_image_type	Original Image type Requires --long option	standard
scp_os_build_version	OS build version Requires --long option	20250101
scp_os_version	OS version Requires --long option	8.8
size	Image size Requires --long option	2429747200
status	Image status Requires --long option	active
updated_at	Updated at Requires --long option	2025-07-26T12:00:00Z
url	Object Storage URL for Image file (only qcow2 format allowed) Requires --long option	https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2
virtual_size	Virtual size Requires --long option	17179869184
visibility	Indicates access permissions for the Image. Private: Can be used only within the Account, Shared: Can be shared between Accounts	private
volumes	Volumes Requires --long option	[{“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}]

3.1.57.2 - 1.1

scpcli virtualserver image pending list
[--scp_image_type <value>]
[--scp_original_image_type <value>]
[--long]

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

Name	Type	Description	Example
scp_image_type optional	string	Image type	`custom`
scp_original_image_type optional	string	Original Image type	`standard`

Responses

Name	Description	Example
id	Image ID	70a599e0-31e7-49b7-b260-868f441e862b
checksum	MD5 hash of the entire image data. and this field could be used to verify the integrity of image. Requires --long option	7538e0fcb56e0e272cfd89eb384d6613
container_format	Container format Requires --long option	bare
created_at	Created at	2025-07-22T09:00:00Z
disk_format	Disk format Requires --long option	qcow2
file	The URL for the virtual server image file Requires --long option	/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file
min_disk	Minimum disk capacity (GB) of the Image to be created Requires --long option	100
min_ram	Minimum RAM capacity (GB) of the Image to be created Requires --long option	0
name	Image name	imagename
os_distro	OS distribution of the image to be uploaded	alma
os_hash_algo	OS hash algorithm used to verify image integrity Requires --long option	sha512
os_hash_value	The actual digest of the image binary, calculated with the algorithm indicated by os_hash_algo. The value is presented as a hexadecimal string. Requires --long option	c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99
os_hidden	Whether the image is hidden Requires --long option	False
owner	Owner account ID Requires --long option	a8f10467abfc4b87b64614ab36eb9ae4
owner_account_name	Owner account name Requires --long option	AccountName
owner_user_name	Owner user name Requires --long option	user@samsung.com
protected	whether Image deletion is prohibited Requires --long option	False
root_device_name	Root device name Requires --long option	/dev/vda
scp_image_type	Image type Requires --long option	custom
scp_k8s_version	K8S version Requires --long option	v1.28.7
scp_original_image_type	Original Image type Requires --long option	standard
scp_os_build_version	OS build version Requires --long option	20250101
scp_os_version	OS version Requires --long option	8.8
size	Image size Requires --long option	2429747200
status	Image status Requires --long option	active
updated_at	Updated at Requires --long option	2025-07-26T12:00:00Z
url	Object Storage URL for Image file (only qcow2 format allowed) Requires --long option	https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2
virtual_size	Virtual size Requires --long option	17179869184
visibility	Indicates access permissions for the Image. Private: Can be used only within the Account, Shared: Can be shared between Accounts	private
volumes	Volumes Requires --long option	[{“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}]

3.1.57.3 - 1.0

scpcli virtualserver image pending list
[--scp_image_type <value>]
[--scp_original_image_type <value>]
[--long]

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

Name	Type	Description	Example
scp_image_type optional	string	Image type	`custom`
scp_original_image_type optional	string	Original Image type	`standard`

Responses

Name	Description	Example
id	Image ID	70a599e0-31e7-49b7-b260-868f441e862b
checksum	MD5 hash of the entire image data. and this field could be used to verify the integrity of image. Requires --long option	7538e0fcb56e0e272cfd89eb384d6613
container_format	Container format Requires --long option	bare
created_at	Created at	2025-07-22T09:00:00Z
disk_format	Disk format Requires --long option	qcow2
file	The URL for the virtual server image file Requires --long option	/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file
min_disk	Minimum disk capacity (GB) of the Image to be created Requires --long option	100
min_ram	Minimum RAM capacity (GB) of the Image to be created Requires --long option	0
name	Image name	imagename
os_distro	OS distribution of the image to be uploaded	alma
os_hash_algo	OS hash algorithm used to verify image integrity Requires --long option	sha512
os_hash_value	The actual digest of the image binary, calculated with the algorithm indicated by os_hash_algo. The value is presented as a hexadecimal string. Requires --long option	c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99
os_hidden	Whether the image is hidden Requires --long option	False
owner	Owner account ID Requires --long option	a8f10467abfc4b87b64614ab36eb9ae4
owner_account_name	Owner account name Requires --long option	AccountName
owner_user_name	Owner user name Requires --long option	user@samsung.com
protected	whether Image deletion is prohibited Requires --long option	False
root_device_name	Root device name Requires --long option	/dev/vda
scp_image_type	Image type Requires --long option	custom
scp_k8s_version	K8S version Requires --long option	v1.28.7
scp_original_image_type	Original Image type Requires --long option	standard
scp_os_build_version	OS build version Requires --long option	20250101
scp_os_version	OS version Requires --long option	8.8
size	Image size Requires --long option	2429747200
status	Image status Requires --long option	active
updated_at	Updated at Requires --long option	2025-07-26T12:00:00Z
url	Object Storage URL for Image file (only qcow2 format allowed) Requires --long option	https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2
virtual_size	Virtual size Requires --long option	17179869184
visibility	Indicates access permissions for the Image. Private: Can be used only within the Account, Shared: Can be shared between Accounts	private
volumes	Volumes Requires --long option	[{“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}]

3.1.58 - List Server Groups

3.1.58.1 - 1.2

scpcli virtualserver server group list
[--limit <value>]
[--offset <value>]
[--long]

Description

Get server group list.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
limit optional	integer	Page size of items	`20`
offset optional	integer	Index of where to start in the list	`0`

Responses

Name	Description	Example
id	Server Group ID	616fb98f-46ca-475e-917e-2563e5a8cd19
account_id	Account ID Requires --long option	a8f10467abfc4b87b64614ab36eb9ae4
members	List of Virtual Servers belonging to Server Group Requires --long option	[‘2a9be312-5d4b-4bc8-b2ae-35100fa9241f’]
name	Server Group name	server-group
partition_size	Size of partition when server group policy is partition Requires --long option	3
policy	Server Group policy	anti-affinity
user_id	User ID Requires --long option	570907805e5447be84b618450ef52o0t

3.1.58.2 - 1.1

scpcli virtualserver server group list
[--limit <value>]
[--offset <value>]
[--long]

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

Name	Type	Description	Example
limit optional	integer	Page size of items	`20`
offset optional	integer	Index of where to start in the list	`0`

Responses

Name	Description	Example
id	Server Group ID	616fb98f-46ca-475e-917e-2563e5a8cd19
account_id	Account ID Requires --long option	a8f10467abfc4b87b64614ab36eb9ae4
members	List of Virtual Servers belonging to Server Group Requires --long option	[‘2a9be312-5d4b-4bc8-b2ae-35100fa9241f’]
name	Server Group name	server-group
partition_size	Size of partition when server group policy is partition Requires --long option	3
policy	Server Group policy	anti-affinity
user_id	User ID Requires --long option	570907805e5447be84b618450ef52o0t

3.1.58.3 - 1.0

scpcli virtualserver server group list
[--limit <value>]
[--offset <value>]
[--long]

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

Name	Type	Description	Example
limit optional	integer	Page size of items	`20`
offset optional	integer	Index of where to start in the list	`0`

Responses

Name	Description	Example
id	Server Group ID	616fb98f-46ca-475e-917e-2563e5a8cd19
account_id	Account ID Requires --long option	a8f10467abfc4b87b64614ab36eb9ae4
members	List of Virtual Servers belonging to Server Group Requires --long option	[‘2a9be312-5d4b-4bc8-b2ae-35100fa9241f’]
name	Server Group name	server-group
partition_size	Size of partition when server group policy is partition Requires --long option	3
policy	Server Group policy	anti-affinity
user_id	User ID Requires --long option	570907805e5447be84b618450ef52o0t

3.1.59 - List Server Interfaces

3.1.59.1 - 1.2

scpcli virtualserver server interface list
--server_id <value>

Description

List Server Interfaces.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`

Responses

Name	Description	Example
fixed_ips	Fixed IP list
is_default	Indicates whether this is the default port.	True
mac_addr	MAC Address	fa:16:3e:c0:71:2b
port_id	Port ID	f2b02fc5-a5fd-4b5f-b1a9-987f4c0d66cc
port_state	Port State	ACTIVE
private_static_nat	Private Static NAT
static_nat	Public Static NAT
subnet_id	Subnet ID	183c6c30df0c4fcbb16422aa2d64aa21

3.1.59.2 - 1.1

scpcli virtualserver server interface list
--server_id <value>

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

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`

Responses

Name	Description	Example
fixed_ips	Fixed IP list
mac_addr	MAC Address	fa:16:3e:c0:71:2b
port_id	Port ID	f2b02fc5-a5fd-4b5f-b1a9-987f4c0d66cc
port_state	Port State	ACTIVE
private_static_nat	Private Static NAT
static_nat	Public Static NAT
subnet_id	Subnet ID	183c6c30df0c4fcbb16422aa2d64aa21

3.1.59.3 - 1.0

scpcli virtualserver server interface list
--server_id <value>

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

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`

Responses

Name	Description	Example
fixed_ips	Fixed IP list
mac_addr	MAC Address	fa:16:3e:c0:71:2b
port_id	Port ID	f2b02fc5-a5fd-4b5f-b1a9-987f4c0d66cc
port_state	Port State	ACTIVE
private_static_nat	Private Static NAT
static_nat	Public Static NAT
subnet_id	Subnet ID	183c6c30df0c4fcbb16422aa2d64aa21

3.1.60 - List Server Ips

3.1.60.1 - 1.2

scpcli virtualserver server ip list
--server_id <value>

Description

List Server Ips.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`

Responses

Name	Description	Example
ip_addresses	IP addresses
subnet_name	Subnet name	subnetname

3.1.60.2 - 1.1

scpcli virtualserver server ip list
--server_id <value>

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

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`

Responses

Name	Description	Example
ip_addresses	IP addresses
subnet_name	Subnet name	subnetname

3.1.60.3 - 1.0

scpcli virtualserver server ip list
--server_id <value>

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

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`

Responses

Name	Description	Example
ip_addresses	IP addresses
subnet_name	Subnet name	subnetname

3.1.61 - List Server Types

3.1.61.1 - 1.2

scpcli virtualserver server type list
[--limit <value>]
[--marker <value>]
[--min_disk <value>]
[--min_ram <value>]
[--sort <value>]

Description

Get server type list.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
limit optional	integer	Page size of items	`20`
marker optional	string	The last item's ID from previous request	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
min_disk optional	integer	Minimum disk size	`0`
min_ram optional	integer	Minimum ram size	`2048`
sort optional	string	Comma-separated list of sort keys and optional sort directions in the form of [:]	`created_at:desc`

Responses

Name	Description	Example
id	Server type ID	s1v1m2
description	Description	description
disk	Size of root disk	100
ephemeral	Size of ephemeral disk	0
extra_specs	Extra specs
name	Server type name	s1v1m2
ram	Amount of RAM	2
swap	Size of dedicated swap disk	0
vcpus	Number of CPUs	1

3.1.61.2 - 1.1

scpcli virtualserver server type list
[--limit <value>]
[--marker <value>]
[--min_disk <value>]
[--min_ram <value>]
[--sort <value>]

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

Name	Type	Description	Example
limit optional	integer	Page size of items	`20`
marker optional	string	The last item's ID from previous request	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
min_disk optional	integer	Minimum disk size	`0`
min_ram optional	integer	Minimum ram size	`2048`
sort optional	string	Comma-separated list of sort keys and optional sort directions in the form of [:]	`created_at:desc`

Responses

Name	Description	Example
id	Server type ID	s1v1m2
description	Description	description
disk	Size of root disk	100
ephemeral	Size of ephemeral disk	0
extra_specs	Extra specs
name	Server type name	s1v1m2
ram	Amount of RAM	2
swap	Size of dedicated swap disk	0
vcpus	Number of CPUs	1

3.1.61.3 - 1.0

scpcli virtualserver server type list
[--limit <value>]
[--marker <value>]
[--min_disk <value>]
[--min_ram <value>]
[--sort <value>]

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

Name	Type	Description	Example
limit optional	integer	Page size of items	`20`
marker optional	string	The last item's ID from previous request	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
min_disk optional	integer	Minimum disk size	`0`
min_ram optional	integer	Minimum ram size	`2048`
sort optional	string	Comma-separated list of sort keys and optional sort directions in the form of [:]	`created_at:desc`

Responses

Name	Description	Example
id	Server type ID	s1v1m2
description	Description	description
disk	Size of root disk	100
ephemeral	Size of ephemeral disk	0
extra_specs	Extra specs
name	Server type name	s1v1m2
ram	Amount of RAM	2
swap	Size of dedicated swap disk	0
vcpus	Number of CPUs	1

3.1.62 - List Server Volumes

3.1.62.1 - 1.2

scpcli virtualserver server volume list
--server_id <value>

Description

List Server Volumes.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`

Responses

Name	Description	Example
id	Volume Attachment ID	3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c
delete_on_termination	Delete the boot volume when the server is terminated.	False
device	Device name such as, /dev/vda.	/dev/vda
server_id	Server ID	2a9be312-5d4b-4bc8-b2ae-35100fa9241f
volume_id	Volume ID	3f500f00-ed80-4566-a057-e31760226f9a

3.1.62.2 - 1.1

scpcli virtualserver server volume list
--server_id <value>

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

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`

Responses

Name	Description	Example
id	Volume Attachment ID	3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c
delete_on_termination	Delete the boot volume when the server is terminated.	False
device	Device name such as, /dev/vda.	/dev/vda
server_id	Server ID	2a9be312-5d4b-4bc8-b2ae-35100fa9241f
volume_id	Volume ID	3f500f00-ed80-4566-a057-e31760226f9a

3.1.62.3 - 1.0

scpcli virtualserver server volume list
--server_id <value>

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

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`

Responses

Name	Description	Example
id	Volume Attachment ID	3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c
delete_on_termination	Delete the boot volume when the server is terminated.	False
device	Device name such as, /dev/vda.	/dev/vda
server_id	Server ID	2a9be312-5d4b-4bc8-b2ae-35100fa9241f
volume_id	Volume ID	3f500f00-ed80-4566-a057-e31760226f9a

3.1.63 - List snapshots

3.1.63.1 - 1.2

scpcli virtualserver volume snapshot list
[--volume_id <value>]
[--limit <value>]
[--offset <value>]
[--marker <value>]
[--with_count <value>]
[--name <value>]
[--sort <value>]

Description

List snapshots.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
volume_id optional	string	Volume ID	`3f500f00-ed80-4566-a057-e31760226f9a`
limit optional	integer	Page size of items	`20`
offset optional	integer	Index of where to start in the list	`0`
marker optional	string	The last item's ID from previous request	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
with_count optional	boolean	Whether to show count	`True`
name optional	string	Snapshot name	`snapshot-1`
sort optional	string	Comma-separated list of sort keys and optional sort directions in the form of [:]	`created_at:desc`

Responses

Name	Description	Example
id	Snapshot ID	cceed636-1f1e-4bb0-b85c-4e5b9e0bf790
created_at	Created at	2025-07-22T09:00:00Z
description	Description	description
metadata	One or more metadata key and value pairs for the snapshot	Metadata
name	Snapshot name	snapshot-1
size	Volume size	104
status	Volume state	available
updated_at	Updated at	2025-07-26T12:00:00Z
user_id	User ID	570907805e5447be84b618450ef52o0t
volume_id	Volume ID	3f500f00-ed80-4566-a057-e31760226f9a

3.1.63.2 - 1.1

scpcli virtualserver volume snapshot list
[--volume_id <value>]
[--limit <value>]
[--offset <value>]
[--marker <value>]
[--with_count <value>]
[--name <value>]

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

Name	Type	Description	Example
volume_id optional	string	Volume ID	`3f500f00-ed80-4566-a057-e31760226f9a`
limit optional	integer	Page size of items	`20`
offset optional	integer	Index of where to start in the list	`0`
marker optional	string	The last item's ID from previous request	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
with_count optional	boolean	Whether to show count	`True`
name optional	string	Snapshot name	`snapshot-1`

Responses

Name	Description	Example
id	Snapshot ID	cceed636-1f1e-4bb0-b85c-4e5b9e0bf790
created_at	Created at	2025-07-22T09:00:00Z
description	Description	description
metadata	One or more metadata key and value pairs for the snapshot	Metadata
name	Snapshot name	snapshot-1
size	Volume size	104
status	Volume state	available
updated_at	Updated at	2025-07-26T12:00:00Z
user_id	User ID	570907805e5447be84b618450ef52o0t
volume_id	Volume ID	3f500f00-ed80-4566-a057-e31760226f9a

3.1.63.3 - 1.0

scpcli virtualserver volume snapshot list
[--volume_id <value>]
[--limit <value>]
[--offset <value>]
[--marker <value>]
[--with_count <value>]
[--name <value>]

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

Name	Type	Description	Example
volume_id optional	string	Volume ID	`3f500f00-ed80-4566-a057-e31760226f9a`
limit optional	integer	Page size of items	`20`
offset optional	integer	Index of where to start in the list	`0`
marker optional	string	The last item's ID from previous request	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
with_count optional	boolean	Whether to show count	`True`
name optional	string	Snapshot name	`snapshot-1`

Responses

Name	Description	Example
id	Snapshot ID	cceed636-1f1e-4bb0-b85c-4e5b9e0bf790
created_at	Created at	2025-07-22T09:00:00Z
description	Description	description
metadata	One or more metadata key and value pairs for the snapshot	Metadata
name	Snapshot name	snapshot-1
size	Volume size	104
status	Volume state	available
updated_at	Updated at	2025-07-26T12:00:00Z
user_id	User ID	570907805e5447be84b618450ef52o0t
volume_id	Volume ID	3f500f00-ed80-4566-a057-e31760226f9a

3.1.64 - List Virtual Server Security Group

3.1.64.1 - 1.2

scpcli virtualserver server security group list
--server_id <value>

Description

List Virtual Server Security Group.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`

Responses

Name	Description	Example
id	Security Group ID	616fb98f-46ca-475e-917e-2563e5a8cd19
account_id	Security Group owner’s account ID	6f70656e737461636b20342065766572
description	Security group description	Security group description
name	Security Group name	securitygroup
rules	Security group rules

3.1.64.2 - 1.1

scpcli virtualserver server security group list
--server_id <value>

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

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`

Responses

Name	Description	Example
id	Security Group ID	616fb98f-46ca-475e-917e-2563e5a8cd19
account_id	Security Group owner’s account ID	6f70656e737461636b20342065766572
description	Security group description	Security group description
name	Security Group name	securitygroup
rules	Security group rules

3.1.64.3 - 1.0

scpcli virtualserver server security group list
--server_id <value>

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

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`

Responses

Name	Description	Example
id	Security Group ID	616fb98f-46ca-475e-917e-2563e5a8cd19
account_id	Security Group owner’s account ID	6f70656e737461636b20342065766572
description	Security group description	Security group description
name	Security Group name	securitygroup
rules	Security group rules

3.1.65 - List Virtual Servers

3.1.65.1 - 1.2

scpcli virtualserver server list
[--name <value>]
[--ip <value>]
[--state <value>]
[--product_category <value>]
[--product_offering <value>]
[--vpc_id <value>]
[--server_type_id <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--auto_scaling_group_id <value>]
[--long]

Description

List Virtual Servers.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
name optional	string	Server name	`servername`
ip optional	string	IP address	`192.169.3.2`
state optional	string	Server state	`ACTIVE`
product_category optional	****	Product category	`compute`
product_offering optional	array	Product offering	`'v'`
vpc_id optional	string	VPC ID	`cc976b621087484ea5fd527f4b78708b`
server_type_id optional	string	Server type ID	`s1v1m2`
limit optional	integer	Page size of items	`20`
marker optional	string	The last item's ID from previous request	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
sort optional	string	Comma-separated list of sort keys and optional sort directions in the form of [:]	`created_at:desc`
auto_scaling_group_id optional	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`

Responses

Name	Description	Example
id	Server ID	2a9be312-5d4b-4bc8-b2ae-35100fa9241f
account_id	Account ID Requires --long option	a8f10467abfc4b87b64614ab36eb9ae4
addresses	Addresses
auto_scaling_group_id	Auto-Scaling Group ID Requires --long option	52613bd852b04b39adcb15a8364d856d
created_at	Created at Requires --long option
created_by	Created by Requires --long option	97e6b22c9a4143789ca522df7457a32f
disk_config	Disk config Requires --long option	MANUAL
image_id	Image ID Requires --long option	70a599e0-31e7-49b7-b260-868f441e862b
is_marketplace	Is Marketplace Requires --long option	False
keypair_name	Keypair name Requires --long option	keypairname
launch_configuration_id	Launch Configuration ID Requires --long option	b5aea5a675fc4f6b9e0fcd1288354c5f
locked	Locked Requires --long option	False
metadata	Metadata Requires --long option
modified_at	Modified at Requires --long option
name	Server name	servername
partition_number	Partition number Requires --long option	1
planned_compute_os_type	Planned Compute OS type Requires --long option	windows
product_category	Product category Requires --long option	compute
product_offering	Product offering Requires --long option	virtual_server
security_groups	Security Groups Requires --long option
server_group_id	Server Group ID Requires --long option	616fb98f-46ca-475e-917e-2563e5a8cd19
server_type	Server type
state	Server state	ACTIVE
volumes	Volumes Requires --long option
vpc_id	VPC ID Requires --long option	cc976b621087484ea5fd527f4b78708b

3.1.65.2 - 1.1

scpcli virtualserver server list
[--name <value>]
[--ip <value>]
[--state <value>]
[--product_category <value>]
[--product_offering <value>]
[--vpc_id <value>]
[--server_type_id <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--auto_scaling_group_id <value>]
[--long]

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

Name	Type	Description	Example
name optional	string	Server name	`servername`
ip optional	string	IP address	`192.169.3.2`
state optional	string	Server state	`ACTIVE`
product_category optional	****	Product category	`compute`
product_offering optional	array	Product offering	`'v'`
vpc_id optional	string	VPC ID	`cc976b621087484ea5fd527f4b78708b`
server_type_id optional	string	Server type ID	`s1v1m2`
limit optional	integer	Page size of items	`20`
marker optional	string	The last item's ID from previous request	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
sort optional	string	Comma-separated list of sort keys and optional sort directions in the form of [:]	`created_at:desc`
auto_scaling_group_id optional	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`

Responses

Name	Description	Example
id	Server ID	2a9be312-5d4b-4bc8-b2ae-35100fa9241f
account_id	Account ID Requires --long option	a8f10467abfc4b87b64614ab36eb9ae4
addresses	Addresses
auto_scaling_group_id	Auto-Scaling Group ID Requires --long option	52613bd852b04b39adcb15a8364d856d
created_at	Created at Requires --long option
created_by	Created by Requires --long option	97e6b22c9a4143789ca522df7457a32f
disk_config	Disk config Requires --long option	MANUAL
image_id	Image ID Requires --long option	70a599e0-31e7-49b7-b260-868f441e862b
is_marketplace	Is Marketplace Requires --long option	False
keypair_name	Keypair name Requires --long option	keypairname
launch_configuration_id	Launch Configuration ID Requires --long option	b5aea5a675fc4f6b9e0fcd1288354c5f
locked	Locked Requires --long option	False
metadata	Metadata Requires --long option
modified_at	Modified at Requires --long option
name	Server name	servername
partition_number	Partition number Requires --long option	1
planned_compute_os_type	Planned Compute OS type Requires --long option	windows
product_category	Product category Requires --long option	compute
product_offering	Product offering Requires --long option	virtual_server
security_groups	Security Groups Requires --long option
server_group_id	Server Group ID Requires --long option	616fb98f-46ca-475e-917e-2563e5a8cd19
server_type	Server type
state	Server state	ACTIVE
volumes	Volumes Requires --long option
vpc_id	VPC ID Requires --long option	cc976b621087484ea5fd527f4b78708b

3.1.65.3 - 1.0

scpcli virtualserver server list
[--name <value>]
[--ip <value>]
[--state <value>]
[--product_category <value>]
[--product_offering <value>]
[--vpc_id <value>]
[--server_type_id <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--auto_scaling_group_id <value>]
[--long]

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

Name	Type	Description	Example
name optional	string	Server name	`servername`
ip optional	string	IP address	`192.169.3.2`
state optional	string	Server state	`ACTIVE`
product_category optional	****	Product category	`compute`
product_offering optional	array	Product offering	`'v'`
vpc_id optional	string	VPC ID	`cc976b621087484ea5fd527f4b78708b`
server_type_id optional	string	Server type ID	`s1v1m2`
limit optional	integer	Page size of items	`20`
marker optional	string	The last item's ID from previous request	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
sort optional	string	Comma-separated list of sort keys and optional sort directions in the form of [:]	`created_at:desc`
auto_scaling_group_id optional	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`

Responses

Name	Description	Example
id	Server ID	2a9be312-5d4b-4bc8-b2ae-35100fa9241f
account_id	Account ID Requires --long option	a8f10467abfc4b87b64614ab36eb9ae4
addresses	Addresses
auto_scaling_group_id	Auto-Scaling Group ID Requires --long option	52613bd852b04b39adcb15a8364d856d
created_at	Created at Requires --long option
created_by	Created by Requires --long option	97e6b22c9a4143789ca522df7457a32f
disk_config	Disk config Requires --long option	MANUAL
image_id	Image ID Requires --long option	70a599e0-31e7-49b7-b260-868f441e862b
is_marketplace	Is Marketplace Requires --long option	False
keypair_name	Keypair name Requires --long option	keypairname
launch_configuration_id	Launch Configuration ID Requires --long option	b5aea5a675fc4f6b9e0fcd1288354c5f
locked	Locked Requires --long option	False
metadata	Metadata Requires --long option
modified_at	Modified at Requires --long option
name	Server name	servername
partition_number	Partition number Requires --long option	1
planned_compute_os_type	Planned Compute OS type Requires --long option	windows
product_category	Product category Requires --long option	compute
product_offering	Product offering Requires --long option	virtual_server
security_groups	Security Groups Requires --long option
server_group_id	Server Group ID Requires --long option	616fb98f-46ca-475e-917e-2563e5a8cd19
server_type	Server type
state	Server state	ACTIVE
volumes	Volumes Requires --long option
vpc_id	VPC ID Requires --long option	cc976b621087484ea5fd527f4b78708b

3.1.66 - List volume transfers

3.1.66.1 - 1.2

scpcli virtualserver volume transfer list

Description

List volume transfers.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Responses

Name	Description	Example
id	Volume Transfer ID	1ac231be-823b-4a4d-8ff0-aac503a7118a
name	Volume name	volume01
volume_id	Volume ID	3f500f00-ed80-4566-a057-e31760226f9a

3.1.66.2 - 1.1

scpcli virtualserver volume transfer list

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

Name	Description	Example
id	Volume Transfer ID	1ac231be-823b-4a4d-8ff0-aac503a7118a
name	Volume name	volume01
volume_id	Volume ID	3f500f00-ed80-4566-a057-e31760226f9a

3.1.66.3 - 1.0

scpcli virtualserver volume transfer list

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

Name	Description	Example
id	Volume Transfer ID	1ac231be-823b-4a4d-8ff0-aac503a7118a
name	Volume name	volume01
volume_id	Volume ID	3f500f00-ed80-4566-a057-e31760226f9a

3.1.67 - List volume types

3.1.67.1 - 1.2

scpcli virtualserver volume type list
[--limit <value>]
[--offset <value>]
[--marker <value>]
[--sort <value>]

Description

List volume types.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
limit optional	integer	Page size of items. Max value is 1000.	`20`
offset optional	integer	Index of where to start in the list	`0`
marker optional	string	The last item's ID from previous request	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
sort optional	string	Comma-separated list of sort keys and optional sort directions in the form of [:]	`created_at:desc`

Responses

Name	Description	Example
id	Volume type ID	c643ac35-3aec-43e6-b97a-3d6f666c5207
description	Volume type description	Volume type description
extra_specs	Extra specs
name	Volume type name	SSD

3.1.67.2 - 1.1

scpcli virtualserver volume type list
[--limit <value>]
[--offset <value>]
[--marker <value>]
[--sort <value>]

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

Name	Type	Description	Example
limit optional	integer	Page size of items. Max value is 1000.	`20`
offset optional	integer	Index of where to start in the list	`0`
marker optional	string	The last item's ID from previous request	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
sort optional	string	Comma-separated list of sort keys and optional sort directions in the form of [:]	`created_at:desc`

Responses

Name	Description	Example
id	Volume type ID	c643ac35-3aec-43e6-b97a-3d6f666c5207
description	Volume type description	Volume type description
extra_specs	Extra specs
name	Volume type name	SSD

3.1.67.3 - 1.0

scpcli virtualserver volume type list
[--limit <value>]
[--offset <value>]
[--marker <value>]
[--sort <value>]

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

Name	Type	Description	Example
limit optional	integer	Page size of items. Max value is 1000.	`20`
offset optional	integer	Index of where to start in the list	`0`
marker optional	string	The last item's ID from previous request	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
sort optional	string	Comma-separated list of sort keys and optional sort directions in the form of [:]	`created_at:desc`

Responses

Name	Description	Example
id	Volume type ID	c643ac35-3aec-43e6-b97a-3d6f666c5207
description	Volume type description	Volume type description
extra_specs	Extra specs
name	Volume type name	SSD

3.1.68 - List volumes

3.1.68.1 - 1.2

scpcli virtualserver volume list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--offset <value>]
[--name <value>]
[--state <value>]
[--bootable <value>]
[--long]

Description

List volumes.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
with_count optional	boolean	Whether to show count	`True`
limit optional	integer	Page size of items. Max value is 1000.	`20`
marker optional	string	The last item's ID from previous request	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
sort optional	string	Comma-separated list of sort keys and optional sort directions in the form of [:]	`created_at:desc`
offset optional	integer	Index of where to start in the list	`0`
name optional	string	Volume name	`volume01`
state optional	string	Volume state	`available`
bootable optional	boolean	Bootable	`False`

Responses

Name	Description	Example
id	Volume ID	3f500f00-ed80-4566-a057-e31760226f9a
bootable	Bootable	False
created_at	Created at
encrypted	Encrypted Requires --long option	True
max_iops	The number of distinct read or write operations a volume can process in a single second. Requires --long option	10000
max_throughput	The actual amount of data (volume) transferred to or from the storage device per second. Requires --long option	500
modified_at	Modified at Requires --long option	2025-07-26T12:00:00Z
multiattach	Connect to two or more servers, no restriction on the number of connected servers per volume, and Virtual Server can connect up to 26 volumes. Requires --long option	False
name	Volume name	volume01
servers	Attached servers Requires --long option
size	Volume size	104
snapshot_id	Snapshot ID Requires --long option	cceed636-1f1e-4bb0-b85c-4e5b9e0bf790
state	Volume state	available
user_id	User ID Requires --long option	570907805e5447be84b618450ef52o0t
volume_image_metadata	Volume Image metadata Requires --long option
volume_type	Volume type	SSD
volume_type_id	Volume type ID Requires --long option	c643ac35-3aec-43e6-b97a-3d6f666c5207

3.1.68.2 - 1.1

scpcli virtualserver volume list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--offset <value>]
[--name <value>]
[--state <value>]
[--bootable <value>]
[--long]

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

Name	Type	Description	Example
with_count optional	boolean	Whether to show count	`True`
limit optional	integer	Page size of items. Max value is 1000.	`20`
marker optional	string	The last item's ID from previous request	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
sort optional	string	Comma-separated list of sort keys and optional sort directions in the form of [:]	`created_at:desc`
offset optional	integer	Index of where to start in the list	`0`
name optional	string	Volume name	`volume01`
state optional	string	Volume state	`available`
bootable optional	boolean	Bootable	`False`

Responses

Name	Description	Example
id	Volume ID	3f500f00-ed80-4566-a057-e31760226f9a
bootable	Bootable	False
created_at	Created at
encrypted	Encrypted Requires --long option	True
modified_at	Modified at Requires --long option	2025-07-26T12:00:00Z
multiattach	Connect to two or more servers, no restriction on the number of connected servers per volume, and Virtual Server can connect up to 26 volumes. Requires --long option	False
name	Volume name	volume01
servers	Attached servers Requires --long option
size	Volume size	104
snapshot_id	Snapshot ID Requires --long option	cceed636-1f1e-4bb0-b85c-4e5b9e0bf790
state	Volume state	available
user_id	User ID Requires --long option	570907805e5447be84b618450ef52o0t
volume_image_metadata	Volume Image metadata Requires --long option
volume_type	Volume type	SSD
volume_type_id	Volume type ID Requires --long option	c643ac35-3aec-43e6-b97a-3d6f666c5207

3.1.68.3 - 1.0

scpcli virtualserver volume list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--offset <value>]
[--name <value>]
[--state <value>]
[--bootable <value>]
[--long]

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

Name	Type	Description	Example
with_count optional	boolean	Whether to show count	`True`
limit optional	integer	Page size of items. Max value is 1000.	`20`
marker optional	string	The last item's ID from previous request	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
sort optional	string	Comma-separated list of sort keys and optional sort directions in the form of [:]	`created_at:desc`
offset optional	integer	Index of where to start in the list	`0`
name optional	string	Volume name	`volume01`
state optional	string	Volume state	`available`
bootable optional	boolean	Bootable	`False`

Responses

Name	Description	Example
id	Volume ID	3f500f00-ed80-4566-a057-e31760226f9a
bootable	Bootable	False
created_at	Created at
encrypted	Encrypted Requires --long option	True
modified_at	Modified at Requires --long option	2025-07-26T12:00:00Z
multiattach	Connect to two or more servers, no restriction on the number of connected servers per volume, and Virtual Server can connect up to 26 volumes. Requires --long option	False
name	Volume name	volume01
servers	Attached servers Requires --long option
size	Volume size	104
snapshot_id	Snapshot ID Requires --long option	cceed636-1f1e-4bb0-b85c-4e5b9e0bf790
state	Volume state	available
user_id	User ID Requires --long option	570907805e5447be84b618450ef52o0t
volume_image_metadata	Volume Image metadata Requires --long option
volume_type	Volume type	SSD
volume_type_id	Volume type ID Requires --long option	c643ac35-3aec-43e6-b97a-3d6f666c5207

3.1.69 - Lock Virtual Server

3.1.69.1 - 1.2

scpcli virtualserver server lock
--server_id <value>

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

Parameters

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`

Responses

Name	Description	Example

3.1.69.2 - 1.1

scpcli virtualserver server lock
--server_id <value>

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

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`

Responses

Name	Description	Example

3.1.69.3 - 1.0

scpcli virtualserver server lock
--server_id <value>

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

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`

Responses

Name	Description	Example

3.1.70 - Reboot Virtual Server

3.1.70.1 - 1.2

scpcli virtualserver server reboot
--server_id <value>
[--reboot_type <value>]

Description

Reboot Virtual Server.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
reboot_type optional	****	Reboot type. A SOFT reboot attempts a graceful shutdown and restart of the server. A HARD reboot attempts a forced shutdown and restart of the server. The HARD reboot corresponds to the power cycles of the server.	`SOFT`

Responses

Name	Description	Example

3.1.70.2 - 1.1

scpcli virtualserver server reboot
--server_id <value>
[--reboot_type <value>]

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

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
reboot_type optional	****	Reboot type. A SOFT reboot attempts a graceful shutdown and restart of the server. A HARD reboot attempts a forced shutdown and restart of the server. The HARD reboot corresponds to the power cycles of the server.	`SOFT`

Responses

Name	Description	Example

3.1.70.3 - 1.0

scpcli virtualserver server reboot
--server_id <value>
[--reboot_type <value>]

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

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
reboot_type optional	****	Reboot type. A SOFT reboot attempts a graceful shutdown and restart of the server. A HARD reboot attempts a forced shutdown and restart of the server. The HARD reboot corresponds to the power cycles of the server.	`SOFT`

Responses

Name	Description	Example

3.1.71 - Rebuild Virtual Server

3.1.71.1 - 1.2

scpcli virtualserver server rebuild
--server_id <value>

Description

Rebuild Virtual Server.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`

Responses

Name	Description	Example

3.1.71.2 - 1.1

scpcli virtualserver server rebuild
--server_id <value>

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

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`

Responses

Name	Description	Example

3.1.71.3 - 1.0

scpcli virtualserver server rebuild
--server_id <value>

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

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`

Responses

Name	Description	Example

3.1.72 - Revert Volume to snapshot

3.1.72.1 - 1.2

scpcli virtualserver volume revert
--volume_id <value>
--snapshot_id <value>

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

Parameters

Name	Type	Description	Example
volume_id required	string	Volume ID	`3f500f00-ed80-4566-a057-e31760226f9a`
snapshot_id required	string	Snapshot ID	`cceed636-1f1e-4bb0-b85c-4e5b9e0bf790`

Responses

Name	Description	Example

3.1.72.2 - 1.1

scpcli virtualserver volume revert
--volume_id <value>
--snapshot_id <value>

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

Name	Type	Description	Example
volume_id required	string	Volume ID	`3f500f00-ed80-4566-a057-e31760226f9a`
snapshot_id required	string	Snapshot ID	`cceed636-1f1e-4bb0-b85c-4e5b9e0bf790`

Responses

Name	Description	Example

3.1.72.3 - 1.0

scpcli virtualserver volume revert
--volume_id <value>
--snapshot_id <value>

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

Name	Type	Description	Example
volume_id required	string	Volume ID	`3f500f00-ed80-4566-a057-e31760226f9a`
snapshot_id required	string	Snapshot ID	`cceed636-1f1e-4bb0-b85c-4e5b9e0bf790`

Responses

Name	Description	Example

3.1.73 - Set Volume Qos

3.1.73.1 - 1.2

scpcli virtualserver volume revert
--volume_id <value>
[--max_iops <value>]
[--max_throughput <value>]

Description

Set Volume Qos

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
volume_id required	string	Volume ID	`3f500f00-ed80-4566-a057-e31760226f9a`
max_iops optional	integer	The number of distinct read or write operations a volume can process in a single second.	`10000`
max_throughput optional	integer	The actual amount of data (volume) transferred to or from the storage device per second.	`500`

3.1.74 - Show a snapshot’s details

3.1.74.1 - 1.2

scpcli virtualserver volume snapshot show
--snapshot_id <value>

Description

Show a snapshot’s details.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

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

Responses

Name	Description	Example
id	Snapshot ID	cceed636-1f1e-4bb0-b85c-4e5b9e0bf790
created_at	Created at	2025-07-22T09:00:00Z
description	Description	description
metadata	One or more metadata key and value pairs for the snapshot	Metadata
name	Snapshot name	snapshot-1
size	Volume size	104
status	Volume state	available
updated_at	Updated at	2025-07-26T12:00:00Z
user_id	User ID	570907805e5447be84b618450ef52o0t
volume_id	Volume ID	3f500f00-ed80-4566-a057-e31760226f9a

3.1.74.2 - 1.1

scpcli virtualserver volume snapshot show
--snapshot_id <value>

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

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

Responses

Name	Description	Example
id	Snapshot ID	cceed636-1f1e-4bb0-b85c-4e5b9e0bf790
created_at	Created at	2025-07-22T09:00:00Z
description	Description	description
metadata	One or more metadata key and value pairs for the snapshot	Metadata
name	Snapshot name	snapshot-1
size	Volume size	104
status	Volume state	available
updated_at	Updated at	2025-07-26T12:00:00Z
user_id	User ID	570907805e5447be84b618450ef52o0t
volume_id	Volume ID	3f500f00-ed80-4566-a057-e31760226f9a

3.1.74.3 - 1.0

scpcli virtualserver volume snapshot show
--snapshot_id <value>

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

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

Responses

Name	Description	Example
id	Snapshot ID	cceed636-1f1e-4bb0-b85c-4e5b9e0bf790
created_at	Created at	2025-07-22T09:00:00Z
description	Description	description
metadata	One or more metadata key and value pairs for the snapshot	Metadata
name	Snapshot name	snapshot-1
size	Volume size	104
status	Volume state	available
updated_at	Updated at	2025-07-26T12:00:00Z
user_id	User ID	570907805e5447be84b618450ef52o0t
volume_id	Volume ID	3f500f00-ed80-4566-a057-e31760226f9a

3.1.75 - Show Auto-Scaling Group

3.1.75.1 - 1.2

scpcli virtualserver auto scaling group show
--auto_scaling_group_id <value>

Description

Show Auto-Scaling Group.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`

Responses

Name	Description	Example
id	LB Server Group ID	d06e87d3-ca9a-461b-8e88-077a542a7335
port	LB Server Group port	8080

3.1.75.2 - 1.1

scpcli virtualserver auto scaling group show
--auto_scaling_group_id <value>

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

Name	Type	Description	Example
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`

Responses

Name	Description	Example
id	LB Server Group ID	d06e87d3-ca9a-461b-8e88-077a542a7335
port	LB Server Group port	8080

3.1.75.3 - 1.0

scpcli virtualserver auto scaling group show
--auto_scaling_group_id <value>

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

Name	Type	Description	Example
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`

Responses

Name	Description	Example
id	LB Server Group ID	d06e87d3-ca9a-461b-8e88-077a542a7335
port	LB Server Group port	8080

3.1.76 - Show Auto-Scaling Group Notification

3.1.76.1 - 1.2

scpcli virtualserver auto scaling group notification show
--notification_id <value>
--auto_scaling_group_id <value>

Description

Show Auto-Scaling Group notification.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
notification_id required	string	Auto-Scaling Group notification ID	`fa7fd191410744cd810a290c0b4d22b9`
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID	a8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_id	Auto-Scaling Group ID	52613bd852b04b39adcb15a8364d856d
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
notification_events	Auto-Scaling Group notification event list	[‘SCALE_OUT’, ‘SCALE_OUT_FAIL’]
notification_state	Auto-Scaling Group notification state	ACTIVE
user_email	User email	scpuser@samsung.com
user_id	User ID	570907805e5447be84b618450ef52o0t
user_name	User name	scpuser

3.1.76.2 - 1.1

scpcli virtualserver auto scaling group notification show
--notification_id <value>
--auto_scaling_group_id <value>

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

Name	Type	Description	Example
notification_id required	string	Auto-Scaling Group notification ID	`fa7fd191410744cd810a290c0b4d22b9`
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID	a8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_id	Auto-Scaling Group ID	52613bd852b04b39adcb15a8364d856d
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
notification_events	Auto-Scaling Group notification event list	[‘SCALE_OUT’, ‘SCALE_OUT_FAIL’]
notification_state	Auto-Scaling Group notification state	ACTIVE
user_email	User email	scpuser@samsung.com
user_id	User ID	570907805e5447be84b618450ef52o0t
user_name	User name	scpuser

3.1.76.3 - 1.0

scpcli virtualserver auto scaling group notification show
--notification_id <value>
--auto_scaling_group_id <value>

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

Name	Type	Description	Example
notification_id required	string	Auto-Scaling Group notification ID	`fa7fd191410744cd810a290c0b4d22b9`
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID	a8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_id	Auto-Scaling Group ID	52613bd852b04b39adcb15a8364d856d
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
notification_events	Auto-Scaling Group notification event list	[‘SCALE_OUT’, ‘SCALE_OUT_FAIL’]
notification_state	Auto-Scaling Group notification state	ACTIVE
user_email	User email	scpuser@samsung.com
user_id	User ID	570907805e5447be84b618450ef52o0t
user_name	User name	scpuser

3.1.77 - Show Auto-Scaling Group Policy

3.1.77.1 - 1.2

scpcli virtualserver auto scaling group policy show
--policy_id <value>
--auto_scaling_group_id <value>

Description

Show Auto-Scaling Group policy.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
policy_id required	string	Policy ID	`0761d76085f54363bab07909baf69841`
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID	a8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_id	Auto-Scaling Group ID	52613bd852b04b39adcb15a8364d856d
comparison_operator	Comparison operator	ge
cooldown_seconds	Cooldown seconds	300
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
evaluation_minutes	Evaluation minutes	5
metric_method	Metric method	AVG
metric_type	Metric type	CPU
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Policy name	policy-name
scale_method	Scale method	AMOUNT
scale_type	Scale type	SCALE_OUT
scale_value	Scale value	10
state	Policy state	ACTIVE
threshold	Threshold	60
threshold_unit	Threshold unit	%

3.1.77.2 - 1.1

scpcli virtualserver auto scaling group policy show
--policy_id <value>
--auto_scaling_group_id <value>

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

Name	Type	Description	Example
policy_id required	string	Policy ID	`0761d76085f54363bab07909baf69841`
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID	a8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_id	Auto-Scaling Group ID	52613bd852b04b39adcb15a8364d856d
comparison_operator	Comparison operator	ge
cooldown_seconds	Cooldown seconds	300
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
evaluation_minutes	Evaluation minutes	5
metric_method	Metric method	AVG
metric_type	Metric type	CPU
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Policy name	policy-name
scale_method	Scale method	AMOUNT
scale_type	Scale type	SCALE_OUT
scale_value	Scale value	10
state	Policy state	ACTIVE
threshold	Threshold	60
threshold_unit	Threshold unit	%

3.1.77.3 - 1.0

scpcli virtualserver auto scaling group policy show
--policy_id <value>
--auto_scaling_group_id <value>

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

Name	Type	Description	Example
policy_id required	string	Policy ID	`0761d76085f54363bab07909baf69841`
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID	a8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_id	Auto-Scaling Group ID	52613bd852b04b39adcb15a8364d856d
comparison_operator	Comparison operator	ge
cooldown_seconds	Cooldown seconds	300
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
evaluation_minutes	Evaluation minutes	5
metric_method	Metric method	AVG
metric_type	Metric type	CPU
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Policy name	policy-name
scale_method	Scale method	AMOUNT
scale_type	Scale type	SCALE_OUT
scale_value	Scale value	10
state	Policy state	ACTIVE
threshold	Threshold	60
threshold_unit	Threshold unit	%

3.1.78 - Show Auto-Scaling Group Schedule

3.1.78.1 - 1.2

scpcli virtualserver auto scaling group schedule show
--schedule_id <value>
--auto_scaling_group_id <value>

Description

Show Auto-Scaling Group schedule.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
schedule_id required	string	Schedule ID	`43d4841abd404220af5f0904037aba71`
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID	a8f10467abfc4b87b64614ab36eb9ae4
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
day_of_month	Day of the month	-1,1
day_of_week	Day of the week	SU,SA
description	Description	description
desired_server_count	Desired server count	1
end_date	End date	2025-01-01
frequency	Frequency	WEEKLY
hour	Hour	9
max_server_count	Max server count	2
min_server_count	Min server count	1
minute	Minute	0
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Schedule name	schedulename
start_date	Start date	2024-01-01
state	Schedule state	ACTIVE
timezone	Timezone	Asia/Seoul

3.1.78.2 - 1.1

scpcli virtualserver auto scaling group schedule show
--schedule_id <value>
--auto_scaling_group_id <value>

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

Name	Type	Description	Example
schedule_id required	string	Schedule ID	`43d4841abd404220af5f0904037aba71`
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID	a8f10467abfc4b87b64614ab36eb9ae4
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
day_of_month	Day of the month	-1,1
day_of_week	Day of the week	SU,SA
description	Description	description
desired_server_count	Desired server count	1
end_date	End date	2025-01-01
frequency	Frequency	WEEKLY
hour	Hour	9
max_server_count	Max server count	2
min_server_count	Min server count	1
minute	Minute	0
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Schedule name	schedulename
start_date	Start date	2024-01-01
state	Schedule state	ACTIVE
timezone	Timezone	Asia/Seoul

3.1.78.3 - 1.0

scpcli virtualserver auto scaling group schedule show
--schedule_id <value>
--auto_scaling_group_id <value>

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

Name	Type	Description	Example
schedule_id required	string	Schedule ID	`43d4841abd404220af5f0904037aba71`
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID	a8f10467abfc4b87b64614ab36eb9ae4
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
day_of_month	Day of the month	-1,1
day_of_week	Day of the week	SU,SA
description	Description	description
desired_server_count	Desired server count	1
end_date	End date	2025-01-01
frequency	Frequency	WEEKLY
hour	Hour	9
max_server_count	Max server count	2
min_server_count	Min server count	1
minute	Minute	0
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Schedule name	schedulename
start_date	Start date	2024-01-01
state	Schedule state	ACTIVE
timezone	Timezone	Asia/Seoul

3.1.79 - Show default Volume type’s details

3.1.79.1 - 1.2

scpcli virtualserver volume type default show

Description

Show a default Volume type’s details.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Responses

Name	Description	Example
id	Volume type ID	c643ac35-3aec-43e6-b97a-3d6f666c5207
description	Volume type description	Volume type description
extra_specs	Extra specs
name	Volume type name	SSD

3.1.79.2 - 1.1

scpcli virtualserver volume type default show

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

Name	Description	Example
id	Volume type ID	c643ac35-3aec-43e6-b97a-3d6f666c5207
description	Volume type description	Volume type description
extra_specs	Extra specs
name	Volume type name	SSD

3.1.79.3 - 1.0

scpcli virtualserver volume type default show

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

Name	Description	Example
id	Volume type ID	c643ac35-3aec-43e6-b97a-3d6f666c5207
description	Volume type description	Volume type description
extra_specs	Extra specs
name	Volume type name	SSD

3.1.80 - Show Image

3.1.80.1 - 1.2

scpcli virtualserver image show
--image_id <value>

Description

Show Image.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

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

Responses

Name	Description	Example
id	Image ID	70a599e0-31e7-49b7-b260-868f441e862b
checksum	MD5 hash of the entire image data. and this field could be used to verify the integrity of image.	7538e0fcb56e0e272cfd89eb384d6613
container_format	Container format	bare
created_at	Created at	2025-07-22T09:00:00Z
disk_format	Disk format	qcow2
file	The URL for the virtual server image file	/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file
min_disk	Minimum disk capacity (GB) of the Image to be created	100
min_ram	Minimum RAM capacity (GB) of the Image to be created	0
name	Image name	imagename
os_distro	OS distribution of the image to be uploaded	alma
os_hash_algo	OS hash algorithm used to verify image integrity	sha512
os_hash_value	The actual digest of the image binary, calculated with the algorithm indicated by os_hash_algo. The value is presented as a hexadecimal string.	c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99
os_hidden	Whether the image is hidden	False
owner	Owner account ID	a8f10467abfc4b87b64614ab36eb9ae4
owner_account_name	Owner account name	AccountName
owner_user_name	Owner user name	user@samsung.com
protected	whether Image deletion is prohibited	False
root_device_name	Root device name	/dev/vda
scp_gpu_driver	K8s GPU Image driver version	535.183.06
scp_image_type	Image type	custom
scp_k8s_version	K8S version	v1.28.7
scp_original_image_type	Original Image type	standard
scp_os_build_version	OS build version	20250101
scp_os_version	OS version	8.8
size	Image size	2429747200
status	Image status	active
updated_at	Updated at	2025-07-26T12:00:00Z
url	Object Storage URL for Image file (only qcow2 format allowed)	https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2
virtual_size	Virtual size	17179869184
visibility	Indicates access permissions for the Image. Private: Can be used only within the Account, Shared: Can be shared between Accounts	private
volumes	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}]

3.1.80.2 - 1.1

scpcli virtualserver image show
--image_id <value>

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

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

Responses

Name	Description	Example
id	Image ID	70a599e0-31e7-49b7-b260-868f441e862b
checksum	MD5 hash of the entire image data. and this field could be used to verify the integrity of image.	7538e0fcb56e0e272cfd89eb384d6613
container_format	Container format	bare
created_at	Created at	2025-07-22T09:00:00Z
disk_format	Disk format	qcow2
file	The URL for the virtual server image file	/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file
min_disk	Minimum disk capacity (GB) of the Image to be created	100
min_ram	Minimum RAM capacity (GB) of the Image to be created	0
name	Image name	imagename
os_distro	OS distribution of the image to be uploaded	alma
os_hash_algo	OS hash algorithm used to verify image integrity	sha512
os_hash_value	The actual digest of the image binary, calculated with the algorithm indicated by os_hash_algo. The value is presented as a hexadecimal string.	c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99
os_hidden	Whether the image is hidden	False
owner	Owner account ID	a8f10467abfc4b87b64614ab36eb9ae4
owner_account_name	Owner account name	AccountName
owner_user_name	Owner user name	user@samsung.com
protected	whether Image deletion is prohibited	False
root_device_name	Root device name	/dev/vda
scp_image_type	Image type	custom
scp_k8s_version	K8S version	v1.28.7
scp_original_image_type	Original Image type	standard
scp_os_build_version	OS build version	20250101
scp_os_version	OS version	8.8
size	Image size	2429747200
status	Image status	active
updated_at	Updated at	2025-07-26T12:00:00Z
url	Object Storage URL for Image file (only qcow2 format allowed)	https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2
virtual_size	Virtual size	17179869184
visibility	Indicates access permissions for the Image. Private: Can be used only within the Account, Shared: Can be shared between Accounts	private
volumes	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}]

3.1.80.3 - 1.0

scpcli virtualserver image show
--image_id <value>

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

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

Responses

Name	Description	Example
id	Image ID	70a599e0-31e7-49b7-b260-868f441e862b
checksum	MD5 hash of the entire image data. and this field could be used to verify the integrity of image.	7538e0fcb56e0e272cfd89eb384d6613
container_format	Container format	bare
created_at	Created at	2025-07-22T09:00:00Z
disk_format	Disk format	qcow2
file	The URL for the virtual server image file	/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file
min_disk	Minimum disk capacity (GB) of the Image to be created	100
min_ram	Minimum RAM capacity (GB) of the Image to be created	0
name	Image name	imagename
os_distro	OS distribution of the image to be uploaded	alma
os_hash_algo	OS hash algorithm used to verify image integrity	sha512
os_hash_value	The actual digest of the image binary, calculated with the algorithm indicated by os_hash_algo. The value is presented as a hexadecimal string.	c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99
os_hidden	Whether the image is hidden	False
owner	Owner account ID	a8f10467abfc4b87b64614ab36eb9ae4
owner_account_name	Owner account name	AccountName
owner_user_name	Owner user name	user@samsung.com
protected	whether Image deletion is prohibited	False
root_device_name	Root device name	/dev/vda
scp_image_type	Image type	custom
scp_k8s_version	K8S version	v1.28.7
scp_original_image_type	Original Image type	standard
scp_os_build_version	OS build version	20250101
scp_os_version	OS version	8.8
size	Image size	2429747200
status	Image status	active
updated_at	Updated at	2025-07-26T12:00:00Z
url	Object Storage URL for Image file (only qcow2 format allowed)	https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2
virtual_size	Virtual size	17179869184
visibility	Indicates access permissions for the Image. Private: Can be used only within the Account, Shared: Can be shared between Accounts	private
volumes	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}]

3.1.81 - Show Image member

3.1.81.1 - 1.2

scpcli virtualserver image member show
--member_id <value>
--image_id <value>

Description

Show Image member.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
member_id required	string	Shared Image member ID	`a8f10467abfc4b87b64614ab36eb9ae4`
image_id required	string	Image ID	`70a599e0-31e7-49b7-b260-868f441e862b`

Responses

Name	Description	Example
created_at	Created at	2025-07-22T09:00:00Z
image_id	Image ID	70a599e0-31e7-49b7-b260-868f441e862b
member_id	Shared Image member ID	a8f10467abfc4b87b64614ab36eb9ae4
status	Status of this Image member. Value of one of pending, accepted, rejected.	pending
updated_at	Updated at	2025-07-26T12:00:00Z

3.1.81.2 - 1.1

scpcli virtualserver image member show
--member_id <value>
--image_id <value>

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

Name	Type	Description	Example
member_id required	string	Shared Image member ID	`a8f10467abfc4b87b64614ab36eb9ae4`
image_id required	string	Image ID	`70a599e0-31e7-49b7-b260-868f441e862b`

Responses

Name	Description	Example
created_at	Created at	2025-07-22T09:00:00Z
image_id	Image ID	70a599e0-31e7-49b7-b260-868f441e862b
member_id	Shared Image member ID	a8f10467abfc4b87b64614ab36eb9ae4
status	Status of this Image member. Value of one of pending, accepted, rejected.	pending
updated_at	Updated at	2025-07-26T12:00:00Z

3.1.81.3 - 1.0

scpcli virtualserver image member show
--member_id <value>
--image_id <value>

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

Name	Type	Description	Example
member_id required	string	Shared Image member ID	`a8f10467abfc4b87b64614ab36eb9ae4`
image_id required	string	Image ID	`70a599e0-31e7-49b7-b260-868f441e862b`

Responses

Name	Description	Example
created_at	Created at	2025-07-22T09:00:00Z
image_id	Image ID	70a599e0-31e7-49b7-b260-868f441e862b
member_id	Shared Image member ID	a8f10467abfc4b87b64614ab36eb9ae4
status	Status of this Image member. Value of one of pending, accepted, rejected.	pending
updated_at	Updated at	2025-07-26T12:00:00Z

3.1.82 - Show Keypair

3.1.82.1 - 1.2

scpcli virtualserver keypair show
--keypair_name <value>

Description

Show keypair.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
keypair_name required	string	Keypair name	`keypairname`

Responses

Name	Description	Example
id	Keypair ID	1
created_at	Created at	2025-07-22T09:00:00Z
fingerprint	Fingerprint	7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd
name	Keypair name	keypairname
public_key	Public Key	ssh-rsa fakeKey Generated-by-SCP
type	Keypair type	ssh
user_id	User ID	570907805e5447be84b618450ef52o0t

3.1.82.2 - 1.1

scpcli virtualserver keypair show
--keypair_name <value>

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

Name	Type	Description	Example
keypair_name required	string	Keypair name	`keypairname`

Responses

Name	Description	Example
id	Keypair ID	1
created_at	Created at	2025-07-22T09:00:00Z
fingerprint	Fingerprint	7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd
name	Keypair name	keypairname
public_key	Public Key	ssh-rsa fakeKey Generated-by-SCP
type	Keypair type	ssh
user_id	User ID	570907805e5447be84b618450ef52o0t

3.1.82.3 - 1.0

scpcli virtualserver keypair show
--keypair_name <value>

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

Name	Type	Description	Example
keypair_name required	string	Keypair name	`keypairname`

Responses

Name	Description	Example
id	Keypair ID	1
created_at	Created at	2025-07-22T09:00:00Z
fingerprint	Fingerprint	7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd
name	Keypair name	keypairname
public_key	Public Key	ssh-rsa fakeKey Generated-by-SCP
type	Keypair type	ssh
user_id	User ID	570907805e5447be84b618450ef52o0t

3.1.83 - Show Launch Configuration

3.1.83.1 - 1.2

scpcli virtualserver launch configuration show
--launch_configuration_id <value>

Description

Show Launch Configuration.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
launch_configuration_id required	string	Launch Configuration ID	`b5aea5a675fc4f6b9e0fcd1288354c5f`

Responses

Name	Description	Example
boot_index	Boot index	0
max_iops	The number of distinct read or write operations a volume can process in a single second.	10000
max_throughput	The actual amount of data (volume) transferred to or from the storage device per second.	500
size	Volume size	104
type	Volume type	SSD

3.1.83.2 - 1.1

scpcli virtualserver launch configuration show
--launch_configuration_id <value>

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

Name	Type	Description	Example
launch_configuration_id required	string	Launch Configuration ID	`b5aea5a675fc4f6b9e0fcd1288354c5f`

Responses

Name	Description	Example
boot_index	Boot index	0
size	Volume size	104
type	Volume type	SSD

3.1.83.3 - 1.0

scpcli virtualserver launch configuration show
--launch_configuration_id <value>

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

Name	Type	Description	Example
launch_configuration_id required	string	Launch Configuration ID	`b5aea5a675fc4f6b9e0fcd1288354c5f`

Responses

Name	Description	Example
boot_index	Boot index	0
size	Volume size	104
type	Volume type	SSD

3.1.84 - Show Server Group

3.1.84.1 - 1.2

scpcli virtualserver server group show
--server_group_id <value>

Description

Show server group.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
server_group_id required	string	Server Group ID	`616fb98f-46ca-475e-917e-2563e5a8cd19`

Responses

Name	Description	Example
id	Server Group ID	616fb98f-46ca-475e-917e-2563e5a8cd19
account_id	Account ID	a8f10467abfc4b87b64614ab36eb9ae4
members	List of Virtual Servers belonging to Server Group	[‘2a9be312-5d4b-4bc8-b2ae-35100fa9241f’]
name	Server Group name	server-group
partition_size	Size of partition when server group policy is partition	3
policy	Server Group policy	anti-affinity
user_id	User ID	570907805e5447be84b618450ef52o0t

3.1.84.2 - 1.1

scpcli virtualserver server group show
--server_group_id <value>

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

Name	Type	Description	Example
server_group_id required	string	Server Group ID	`616fb98f-46ca-475e-917e-2563e5a8cd19`

Responses

Name	Description	Example
id	Server Group ID	616fb98f-46ca-475e-917e-2563e5a8cd19
account_id	Account ID	a8f10467abfc4b87b64614ab36eb9ae4
members	List of Virtual Servers belonging to Server Group	[‘2a9be312-5d4b-4bc8-b2ae-35100fa9241f’]
name	Server Group name	server-group
partition_size	Size of partition when server group policy is partition	3
policy	Server Group policy	anti-affinity
user_id	User ID	570907805e5447be84b618450ef52o0t

3.1.84.3 - 1.0

scpcli virtualserver server group show
--server_group_id <value>

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

Name	Type	Description	Example
server_group_id required	string	Server Group ID	`616fb98f-46ca-475e-917e-2563e5a8cd19`

Responses

Name	Description	Example
id	Server Group ID	616fb98f-46ca-475e-917e-2563e5a8cd19
account_id	Account ID	a8f10467abfc4b87b64614ab36eb9ae4
members	List of Virtual Servers belonging to Server Group	[‘2a9be312-5d4b-4bc8-b2ae-35100fa9241f’]
name	Server Group name	server-group
partition_size	Size of partition when server group policy is partition	3
policy	Server Group policy	anti-affinity
user_id	User ID	570907805e5447be84b618450ef52o0t

3.1.85 - Show Server Interface

3.1.85.1 - 1.2

scpcli virtualserver server interface show
--port_id <value>
--server_id <value>

Description

Show Server Interface.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
port_id required	string	Port ID	`91424c08-0b26-49fb-9808-ed042292ceef`
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`

Responses

Name	Description	Example
fixed_ips	Fixed IP list
is_default	Indicates whether this is the default port.	True
mac_addr	MAC Address	fa:16:3e:c0:71:2b
port_id	Port ID	f2b02fc5-a5fd-4b5f-b1a9-987f4c0d66cc
port_state	Port State	ACTIVE
private_static_nat	Private Static NAT
static_nat	Public Static NAT
subnet_id	Subnet ID	183c6c30df0c4fcbb16422aa2d64aa21

3.1.85.2 - 1.1

scpcli virtualserver server interface show
--port_id <value>
--server_id <value>

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

Name	Type	Description	Example
port_id required	string	Port ID	`91424c08-0b26-49fb-9808-ed042292ceef`
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`

Responses

Name	Description	Example
fixed_ips	Fixed IP list
mac_addr	MAC Address	fa:16:3e:c0:71:2b
port_id	Port ID	f2b02fc5-a5fd-4b5f-b1a9-987f4c0d66cc
port_state	Port State	ACTIVE
private_static_nat	Private Static NAT
static_nat	Public Static NAT
subnet_id	Subnet ID	183c6c30df0c4fcbb16422aa2d64aa21

3.1.85.3 - 1.0

scpcli virtualserver server interface show
--port_id <value>
--server_id <value>

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

Name	Type	Description	Example
port_id required	string	Port ID	`91424c08-0b26-49fb-9808-ed042292ceef`
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`

Responses

Name	Description	Example
fixed_ips	Fixed IP list
mac_addr	MAC Address	fa:16:3e:c0:71:2b
port_id	Port ID	f2b02fc5-a5fd-4b5f-b1a9-987f4c0d66cc
port_state	Port State	ACTIVE
private_static_nat	Private Static NAT
static_nat	Public Static NAT
subnet_id	Subnet ID	183c6c30df0c4fcbb16422aa2d64aa21

3.1.86 - Show Server Ip

3.1.86.1 - 1.2

scpcli virtualserver server ip show
--subnet_id <value>
--server_id <value>

Description

Show Server Ip.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
subnet_id required	string	Subnet ID	`78b2ee3f074145c580ab6abac4821f97`
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`

Responses

Name	Description	Example
ip_address	IP address	192.169.3.2
version	IP address version	4

3.1.86.2 - 1.1

scpcli virtualserver server ip show
--subnet_id <value>
--server_id <value>

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

Name	Type	Description	Example
subnet_id required	string	Subnet ID	`78b2ee3f074145c580ab6abac4821f97`
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`

Responses

Name	Description	Example
ip_address	IP address	192.169.3.2
version	IP address version	4

3.1.86.3 - 1.0

scpcli virtualserver server ip show
--subnet_id <value>
--server_id <value>

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

Name	Type	Description	Example
subnet_id required	string	Subnet ID	`78b2ee3f074145c580ab6abac4821f97`
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`

Responses

Name	Description	Example
ip_address	IP address	192.169.3.2
version	IP address version	4

3.1.87 - Show Server Quota Set

3.1.87.1 - 1.2

scpcli virtualserver quota set show

Description

Show server quota Set.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Responses

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

3.1.87.2 - 1.1

scpcli virtualserver quota set show

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

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

3.1.87.3 - 1.0

scpcli virtualserver quota set show

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

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

3.1.88 - Show Server Type

3.1.88.1 - 1.2

scpcli virtualserver server type show
--server_type_id <value>

Description

Show server type.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
server_type_id required	string	Server type ID	`s1v1m2`

Responses

Name	Description	Example
id	Server type ID	s1v1m2
description	Description	description
disk	Size of root disk	100
ephemeral	Size of ephemeral disk	0
extra_specs	Extra specs
name	Server type name	s1v1m2
ram	Amount of RAM	2
swap	Size of dedicated swap disk	0
vcpus	Number of CPUs	1

3.1.88.2 - 1.1

scpcli virtualserver server type show
--server_type_id <value>

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

Name	Type	Description	Example
server_type_id required	string	Server type ID	`s1v1m2`

Responses

Name	Description	Example
id	Server type ID	s1v1m2
description	Description	description
disk	Size of root disk	100
ephemeral	Size of ephemeral disk	0
extra_specs	Extra specs
name	Server type name	s1v1m2
ram	Amount of RAM	2
swap	Size of dedicated swap disk	0
vcpus	Number of CPUs	1

3.1.88.3 - 1.0

scpcli virtualserver server type show
--server_type_id <value>

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

Name	Type	Description	Example
server_type_id required	string	Server type ID	`s1v1m2`

Responses

Name	Description	Example
id	Server type ID	s1v1m2
description	Description	description
disk	Size of root disk	100
ephemeral	Size of ephemeral disk	0
extra_specs	Extra specs
name	Server type name	s1v1m2
ram	Amount of RAM	2
swap	Size of dedicated swap disk	0
vcpus	Number of CPUs	1

3.1.89 - Show Server Volume

3.1.89.1 - 1.2

scpcli virtualserver server volume show
--volume_id <value>
--server_id <value>

Description

Show Server Volume.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
volume_id required	string	Volume ID	`3f500f00-ed80-4566-a057-e31760226f9a`
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`

Responses

Name	Description	Example
id	Volume Attachment ID	3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c
delete_on_termination	Delete the boot volume when the server is terminated.	False
device	Device name such as, /dev/vda.	/dev/vda
server_id	Server ID	2a9be312-5d4b-4bc8-b2ae-35100fa9241f
volume_id	Volume ID	3f500f00-ed80-4566-a057-e31760226f9a

3.1.89.2 - 1.1

scpcli virtualserver server volume show
--volume_id <value>
--server_id <value>

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

Name	Type	Description	Example
volume_id required	string	Volume ID	`3f500f00-ed80-4566-a057-e31760226f9a`
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`

Responses

Name	Description	Example
id	Volume Attachment ID	3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c
delete_on_termination	Delete the boot volume when the server is terminated.	False
device	Device name such as, /dev/vda.	/dev/vda
server_id	Server ID	2a9be312-5d4b-4bc8-b2ae-35100fa9241f
volume_id	Volume ID	3f500f00-ed80-4566-a057-e31760226f9a

3.1.89.3 - 1.0

scpcli virtualserver server volume show
--volume_id <value>
--server_id <value>

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

Name	Type	Description	Example
volume_id required	string	Volume ID	`3f500f00-ed80-4566-a057-e31760226f9a`
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`

Responses

Name	Description	Example
id	Volume Attachment ID	3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c
delete_on_termination	Delete the boot volume when the server is terminated.	False
device	Device name such as, /dev/vda.	/dev/vda
server_id	Server ID	2a9be312-5d4b-4bc8-b2ae-35100fa9241f
volume_id	Volume ID	3f500f00-ed80-4566-a057-e31760226f9a

3.1.90 - Show Virtual Server

3.1.90.1 - 1.2

scpcli virtualserver server show
--server_id <value>

Description

Show Virtual Server.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`

Responses

Name	Description	Example
ip_addresses	IP addresses
subnet_name	Subnet name	subnetname

3.1.90.2 - 1.1

scpcli virtualserver server show
--server_id <value>

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

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`

Responses

Name	Description	Example
ip_addresses	IP addresses
subnet_name	Subnet name	subnetname

3.1.90.3 - 1.0

scpcli virtualserver server show
--server_id <value>

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

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`

Responses

Name	Description	Example
ip_addresses	IP addresses
subnet_name	Subnet name	subnetname

3.1.91 - Show Virtual Server Console Log

3.1.91.1 - 1.2

scpcli virtualserver server console log show
--server_id <value>
[--line_size <value>]

Description

Show Virtual Server Console Log.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
line_size optional	integer	Number of log lines to get	`1`

Responses

Name	Description	Example
output	Server console log output	FAKE CONSOLE OUTPUT

3.1.91.2 - 1.1

scpcli virtualserver server console log show
--server_id <value>
[--line_size <value>]

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

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
line_size optional	integer	Number of log lines to get	`1`

Responses

Name	Description	Example
output	Server console log output	FAKE CONSOLE OUTPUT

3.1.91.3 - 1.0

scpcli virtualserver server console log show
--server_id <value>
[--line_size <value>]

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

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
line_size optional	integer	Number of log lines to get	`1`

Responses

Name	Description	Example
output	Server console log output	FAKE CONSOLE OUTPUT

3.1.92 - Show Virtual Server Password

3.1.92.1 - 1.2

scpcli virtualserver server password show
--server_id <value>
[--private_key <value>]

Description

Show Virtual Server Password.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
private_key optional	string	Private key	```—–BEGIN RSA PRIVATE KEY—–
fakeKey
—–END RSA PRIVATE KEY—–```

Responses

Name	Description	Example
password	Server password	password

3.1.92.2 - 1.1

scpcli virtualserver server password show
--server_id <value>
[--private_key <value>]

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

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
private_key optional	string	Private key	```—–BEGIN RSA PRIVATE KEY—–
fakeKey
—–END RSA PRIVATE KEY—–```

Responses

Name	Description	Example
password	Server password	password

3.1.92.3 - 1.0

scpcli virtualserver server password show
--server_id <value>
[--private_key <value>]

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

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
private_key optional	string	Private key	```—–BEGIN RSA PRIVATE KEY—–
fakeKey
—–END RSA PRIVATE KEY—–```

Responses

Name	Description	Example
password	Server password	password

3.1.93 - Show Volume Quota Set

3.1.93.1 - 1.2

scpcli virtualserver volume quota set show

Description

Show volume quota set.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Responses

Name	Description	Example
id	Quota set ID	fc7283354c6143a58629b59f4c3e16b2
per_volume_size	Per volume size quota
snapshots	Snapshot Quota
usages	Usage quota
volumes	Volume Quota

3.1.93.2 - 1.1

scpcli virtualserver volume quota set show

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

Name	Description	Example
id	Quota set ID	fc7283354c6143a58629b59f4c3e16b2
per_volume_size	Per volume size quota
snapshots	Snapshot Quota
usages	Usage quota
volumes	Volume Quota

3.1.93.3 - 1.0

scpcli virtualserver volume quota set show

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

Name	Description	Example
id	Quota set ID	fc7283354c6143a58629b59f4c3e16b2
per_volume_size	Per volume size quota
snapshots	Snapshot Quota
usages	Usage quota
volumes	Volume Quota

3.1.94 - Show volume transfer detail

3.1.94.1 - 1.2

scpcli virtualserver volume transfer show
--transfer_id <value>

Description

Show volume transfer detail.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
transfer_id required	string	Volume Transfer ID	`1ac231be-823b-4a4d-8ff0-aac503a7118a`

Responses

Name	Description	Example
id	Volume Transfer ID	1ac231be-823b-4a4d-8ff0-aac503a7118a
created_at	Created at	2025-07-22T09:00:00Z
name	Volume name	volume01
volume_id	Volume ID	3f500f00-ed80-4566-a057-e31760226f9a

3.1.94.2 - 1.1

scpcli virtualserver volume transfer show
--transfer_id <value>

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

Name	Type	Description	Example
transfer_id required	string	Volume Transfer ID	`1ac231be-823b-4a4d-8ff0-aac503a7118a`

Responses

Name	Description	Example
id	Volume Transfer ID	1ac231be-823b-4a4d-8ff0-aac503a7118a
created_at	Created at	2025-07-22T09:00:00Z
name	Volume name	volume01
volume_id	Volume ID	3f500f00-ed80-4566-a057-e31760226f9a

3.1.94.3 - 1.0

scpcli virtualserver volume transfer show
--transfer_id <value>

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

Name	Type	Description	Example
transfer_id required	string	Volume Transfer ID	`1ac231be-823b-4a4d-8ff0-aac503a7118a`

Responses

Name	Description	Example
id	Volume Transfer ID	1ac231be-823b-4a4d-8ff0-aac503a7118a
created_at	Created at	2025-07-22T09:00:00Z
name	Volume name	volume01
volume_id	Volume ID	3f500f00-ed80-4566-a057-e31760226f9a

3.1.95 - Show Volume type’s details

3.1.95.1 - 1.2

scpcli virtualserver volume type show
--volume_type_id <value>

Description

Show a Volume type’s details.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
volume_type_id required	string	Volume type ID	`c643ac35-3aec-43e6-b97a-3d6f666c5207`

Responses

Name	Description	Example
id	Volume type ID	c643ac35-3aec-43e6-b97a-3d6f666c5207
description	Volume type description	Volume type description
extra_specs	Extra specs
name	Volume type name	SSD

3.1.95.2 - 1.1

scpcli virtualserver volume type show
--volume_type_id <value>

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

Name	Type	Description	Example
volume_type_id required	string	Volume type ID	`c643ac35-3aec-43e6-b97a-3d6f666c5207`

Responses

Name	Description	Example
id	Volume type ID	c643ac35-3aec-43e6-b97a-3d6f666c5207
description	Volume type description	Volume type description
extra_specs	Extra specs
name	Volume type name	SSD

3.1.95.3 - 1.0

scpcli virtualserver volume type show
--volume_type_id <value>

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

Name	Type	Description	Example
volume_type_id required	string	Volume type ID	`c643ac35-3aec-43e6-b97a-3d6f666c5207`

Responses

Name	Description	Example
id	Volume type ID	c643ac35-3aec-43e6-b97a-3d6f666c5207
description	Volume type description	Volume type description
extra_specs	Extra specs
name	Volume type name	SSD

3.1.96 - Show Volume's details

3.1.96.1 - 1.2

scpcli virtualserver volume show
--volume_id <value>

Description

Show a Volume’s details.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
volume_id required	string	Volume ID	`3f500f00-ed80-4566-a057-e31760226f9a`

Responses

Name	Description	Example
id	Server ID	2a9be312-5d4b-4bc8-b2ae-35100fa9241f
attached_at	The time when the volume was attached to the server.
device	Device name such as, /dev/vda.	/dev/vda

3.1.96.2 - 1.1

scpcli virtualserver volume show
--volume_id <value>

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

Name	Type	Description	Example
volume_id required	string	Volume ID	`3f500f00-ed80-4566-a057-e31760226f9a`

Responses

Name	Description	Example
id	Server ID	2a9be312-5d4b-4bc8-b2ae-35100fa9241f
attached_at	The time when the volume was attached to the server.
device	Device name such as, /dev/vda.	/dev/vda

3.1.96.3 - 1.0

scpcli virtualserver volume show
--volume_id <value>

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

Name	Type	Description	Example
volume_id required	string	Volume ID	`3f500f00-ed80-4566-a057-e31760226f9a`

Responses

Name	Description	Example
id	Server ID	2a9be312-5d4b-4bc8-b2ae-35100fa9241f
attached_at	The time when the volume was attached to the server.
device	Device name such as, /dev/vda.	/dev/vda

3.1.97 - Start Virtual Server

3.1.97.1 - 1.2

scpcli virtualserver server start
--server_id <value>

Description

Start Virtual Server.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`

Responses

Name	Description	Example

3.1.97.2 - 1.1

scpcli virtualserver server start
--server_id <value>

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

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`

Responses

Name	Description	Example

3.1.97.3 - 1.0

scpcli virtualserver server start
--server_id <value>

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

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`

Responses

Name	Description	Example

3.1.98 - Stop Virtual Server

3.1.98.1 - 1.2

scpcli virtualserver server stop
--server_id <value>

Description

Stop Virtual Server.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`

Responses

Name	Description	Example

3.1.98.2 - 1.1

scpcli virtualserver server stop
--server_id <value>

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

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`

Responses

Name	Description	Example

3.1.98.3 - 1.0

scpcli virtualserver server stop
--server_id <value>

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

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`

Responses

Name	Description	Example

3.1.99 - Unlock Virtual Server

3.1.99.1 - 1.2

scpcli virtualserver server unlock
--server_id <value>

Description

Unlock Virtual Server.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`

Responses

Name	Description	Example

3.1.99.2 - 1.1

scpcli virtualserver server unlock
--server_id <value>

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

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`

Responses

Name	Description	Example

3.1.99.3 - 1.0

scpcli virtualserver server unlock
--server_id <value>

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

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`

Responses

Name	Description	Example

3.1.100 - Update a snapshot

3.1.100.1 - 1.2

scpcli virtualserver volume snapshot set
--snapshot_id <value>
--name <value>
[--description <value>]

Description

Update a snapshot.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
snapshot_id required	string	Snapshot ID	`cceed636-1f1e-4bb0-b85c-4e5b9e0bf790`
name required	string	Snapshot name	`snapshot-1`
description optional	string	Description	`description`

3.1.100.2 - 1.1

scpcli virtualserver volume snapshot set
--snapshot_id <value>
--name <value>
[--description <value>]

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

Name	Type	Description	Example
snapshot_id required	string	Snapshot ID	`cceed636-1f1e-4bb0-b85c-4e5b9e0bf790`
name required	string	Snapshot name	`snapshot-1`
description optional	string	Description	`description`

3.1.100.3 - 1.0

scpcli virtualserver volume snapshot set
--snapshot_id <value>
--name <value>
[--description <value>]

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

Name	Type	Description	Example
snapshot_id required	string	Snapshot ID	`cceed636-1f1e-4bb0-b85c-4e5b9e0bf790`
name required	string	Snapshot name	`snapshot-1`
description optional	string	Description	`description`

3.1.101 - Update Auto-Scaling Group

3.1.101.1 - 1.2

scpcli virtualserver auto scaling group set
--auto_scaling_group_id <value>
[--desired_server_count_editable <value>]
[--drain_enabled <value>]
[--drain_timeout <value>]
[--launch_configuration_id <value>]
[--security_group_ids <value>]
[--state_check_delay_time <value>]
[--use_lb_state_check <value>]

Description

Update Auto-Scaling Group.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`
desired_server_count_editable optional	boolean	Desired server count editable	`True`
drain_enabled optional	boolean	Drain enabled	`True`
drain_timeout optional	integer	Drain timeout	`300`
launch_configuration_id optional	string	Launch Configuration ID	`b5aea5a675fc4f6b9e0fcd1288354c5f`
security_group_ids optional	array	Security Group ID list	`c09c3f05-03d9-443f-b27a-40e0f973c75f`
state_check_delay_time optional	integer	The delay time between ASG VM creation and state check operation	`300`
use_lb_state_check optional	boolean	Whether LB state check operates or not	`True`

3.1.101.2 - 1.1

scpcli virtualserver auto scaling group set
--auto_scaling_group_id <value>
[--desired_server_count_editable <value>]
[--drain_enabled <value>]
[--drain_timeout <value>]
[--launch_configuration_id <value>]
[--security_group_ids <value>]

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

Name	Type	Description	Example
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`
desired_server_count_editable optional	boolean	Desired server count editable	`True`
drain_enabled optional	boolean	Drain enabled	`True`
drain_timeout optional	integer	Drain timeout	`300`
launch_configuration_id optional	string	Launch Configuration ID	`b5aea5a675fc4f6b9e0fcd1288354c5f`
security_group_ids optional	array	Security Group ID list	`c09c3f05-03d9-443f-b27a-40e0f973c75f`

3.1.101.3 - 1.0

scpcli virtualserver auto scaling group set
--auto_scaling_group_id <value>
[--desired_server_count_editable <value>]
[--drain_enabled <value>]
[--drain_timeout <value>]
[--launch_configuration_id <value>]
[--security_group_ids <value>]

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

Name	Type	Description	Example
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`
desired_server_count_editable optional	boolean	Desired server count editable	`True`
drain_enabled optional	boolean	Drain enabled	`True`
drain_timeout optional	integer	Drain timeout	`300`
launch_configuration_id optional	string	Launch Configuration ID	`b5aea5a675fc4f6b9e0fcd1288354c5f`
security_group_ids optional	array	Security Group ID list	`c09c3f05-03d9-443f-b27a-40e0f973c75f`

3.1.102 - Update Auto-Scaling Group LB Server Groups

3.1.102.1 - 1.2

scpcli virtualserver auto scaling group lb server group set
--auto_scaling_group_id <value>
--lb_server_groups <value>

Description

Update Auto-Scaling Group LB Server Groups.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`
lb_server_groups required	array	LB Server Group list	`'{"id": "d06e87d3-ca9a-461b-8e88-077a542a7335", "port": 8080}'`

3.1.102.2 - 1.1

scpcli virtualserver auto scaling group lb server group set
--auto_scaling_group_id <value>
--lb_server_groups <value>

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

Name	Type	Description	Example
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`
lb_server_groups required	array	LB Server Group list	`'{"id": "d06e87d3-ca9a-461b-8e88-077a542a7335", "port": 8080}'`

3.1.102.3 - 1.0

scpcli virtualserver auto scaling group lb server group set
--auto_scaling_group_id <value>
--lb_server_groups <value>

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

Name	Type	Description	Example
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`
lb_server_groups required	array	LB Server Group list	`'{"id": "d06e87d3-ca9a-461b-8e88-077a542a7335", "port": 8080}'`

3.1.103 - Update Auto-Scaling Group Notification

3.1.103.1 - 1.2

scpcli virtualserver auto scaling group notification update
--notification_id <value>
--auto_scaling_group_id <value>
[--notification_events <value>]
[--notification_state <value>]

Description

Update Auto-Scaling Group notification.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
notification_id required	string	Auto-Scaling Group notification ID	`fa7fd191410744cd810a290c0b4d22b9`
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`
notification_events optional	array	Auto-Scaling Group notification event list	`'{}'`
notification_state optional	string	Auto-Scaling Group notification state	`ACTIVE`

3.1.103.2 - 1.1

scpcli virtualserver auto scaling group notification update
--notification_id <value>
--auto_scaling_group_id <value>
[--notification_events <value>]
[--notification_state <value>]

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

Name	Type	Description	Example
notification_id required	string	Auto-Scaling Group notification ID	`fa7fd191410744cd810a290c0b4d22b9`
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`
notification_events optional	array	Auto-Scaling Group notification event list	`'{}'`
notification_state optional	string	Auto-Scaling Group notification state	`ACTIVE`

3.1.103.3 - 1.0

scpcli virtualserver auto scaling group notification update
--notification_id <value>
--auto_scaling_group_id <value>
[--notification_events <value>]
[--notification_state <value>]

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

Name	Type	Description	Example
notification_id required	string	Auto-Scaling Group notification ID	`fa7fd191410744cd810a290c0b4d22b9`
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`
notification_events optional	array	Auto-Scaling Group notification event list	`'{}'`
notification_state optional	string	Auto-Scaling Group notification state	`ACTIVE`

3.1.104 - Update Auto-Scaling Group Policy

3.1.104.1 - 1.2

scpcli virtualserver auto scaling group policy set
--policy_id <value>
--auto_scaling_group_id <value>
[--comparison_operator <value>]
[--cooldown_seconds <value>]
[--evaluation_minutes <value>]
[--metric_method <value>]
[--metric_type <value>]
[--scale_method <value>]
[--scale_type <value>]
[--scale_value <value>]
[--state <value>]
[--threshold <value>]

Description

Update Auto-Scaling Group policy.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
policy_id required	string	Policy ID	`0761d76085f54363bab07909baf69841`
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`
comparison_operator optional	string	Comparison operator	`ge`
cooldown_seconds optional	integer	Cooldown seconds	`300`
evaluation_minutes optional	integer	Evaluation minutes	`5`
metric_method optional	string	Metric method	`AVG`
metric_type optional	string	Metric type	`CPU`
scale_method optional	string	Scale method	`AMOUNT`
scale_type optional	string	Scale type	`SCALE_OUT`
scale_value optional	integer	Scale value	`10`
state optional	string	Policy state	`ACTIVE`
threshold optional	integer	Threshold	`60`

3.1.104.2 - 1.1

scpcli virtualserver auto scaling group policy set
--policy_id <value>
--auto_scaling_group_id <value>
[--comparison_operator <value>]
[--cooldown_seconds <value>]
[--evaluation_minutes <value>]
[--metric_method <value>]
[--metric_type <value>]
[--name <value>]
[--scale_method <value>]
[--scale_type <value>]
[--scale_value <value>]
[--state <value>]
[--threshold <value>]

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

Name	Type	Description	Example
policy_id required	string	Policy ID	`0761d76085f54363bab07909baf69841`
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`
comparison_operator optional	string	Comparison operator	`ge`
cooldown_seconds optional	integer	Cooldown seconds	`300`
evaluation_minutes optional	integer	Evaluation minutes	`5`
metric_method optional	string	Metric method	`AVG`
metric_type optional	string	Metric type	`CPU`
name optional	string	Policy name	`policy-name`
scale_method optional	string	Scale method	`AMOUNT`
scale_type optional	string	Scale type	`SCALE_OUT`
scale_value optional	integer	Scale value	`10`
state optional	string	Policy state	`ACTIVE`
threshold optional	integer	Threshold	`60`

3.1.104.3 - 1.0

scpcli virtualserver auto scaling group policy set
--policy_id <value>
--auto_scaling_group_id <value>
[--comparison_operator <value>]
[--cooldown_seconds <value>]
[--evaluation_minutes <value>]
[--metric_method <value>]
[--metric_type <value>]
[--name <value>]
[--scale_method <value>]
[--scale_type <value>]
[--scale_value <value>]
[--state <value>]
[--threshold <value>]

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

Name	Type	Description	Example
policy_id required	string	Policy ID	`0761d76085f54363bab07909baf69841`
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`
comparison_operator optional	string	Comparison operator	`ge`
cooldown_seconds optional	integer	Cooldown seconds	`300`
evaluation_minutes optional	integer	Evaluation minutes	`5`
metric_method optional	string	Metric method	`AVG`
metric_type optional	string	Metric type	`CPU`
name optional	string	Policy name	`policy-name`
scale_method optional	string	Scale method	`AMOUNT`
scale_type optional	string	Scale type	`SCALE_OUT`
scale_value optional	integer	Scale value	`10`
state optional	string	Policy state	`ACTIVE`
threshold optional	integer	Threshold	`60`

3.1.105 - Update Auto-Scaling Group Schedule

3.1.105.1 - 1.2

scpcli virtualserver auto scaling group schedule set
--schedule_id <value>
--auto_scaling_group_id <value>
[--day_of_month <value>]
[--day_of_week <value>]
[--description <value>]
[--desired_server_count <value>]
[--end_date <value>]
[--frequency <value>]
[--hour <value>]
[--max_server_count <value>]
[--min_server_count <value>]
[--minute <value>]
[--name <value>]
[--start_date <value>]
[--state <value>]
[--timezone <value>]

Description

Update Auto-Scaling Group schedule.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
schedule_id required	string	Schedule ID	`43d4841abd404220af5f0904037aba71`
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`
day_of_month optional	string	Day of the month	`-1,1`
day_of_week optional	string	Day of the week	`SU,SA`
description optional	string	Description	`description`
desired_server_count optional	integer	Desired server count	`1`
end_date optional	string	End date	`2025-01-01`
frequency optional	****	Frequency	`WEEKLY`
hour optional	integer	Hour	`9`
max_server_count optional	integer	Max server count	`2`
min_server_count optional	integer	Min server count	`1`
minute optional	integer	Minute	`0`
name optional	string	Schedule name	`schedulename`
start_date optional	string	Start date	`2024-01-01`
state optional	string	Schedule state	`ACTIVE`
timezone optional	string	Timezone	`Asia/Seoul`

3.1.105.2 - 1.1

scpcli virtualserver auto scaling group schedule set
--schedule_id <value>
--auto_scaling_group_id <value>
[--day_of_month <value>]
[--day_of_week <value>]
[--description <value>]
[--desired_server_count <value>]
[--end_date <value>]
[--frequency <value>]
[--hour <value>]
[--max_server_count <value>]
[--min_server_count <value>]
[--minute <value>]
[--name <value>]
[--start_date <value>]
[--state <value>]
[--timezone <value>]

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

Name	Type	Description	Example
schedule_id required	string	Schedule ID	`43d4841abd404220af5f0904037aba71`
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`
day_of_month optional	string	Day of the month	`-1,1`
day_of_week optional	string	Day of the week	`SU,SA`
description optional	string	Description	`description`
desired_server_count optional	integer	Desired server count	`1`
end_date optional	string	End date	`2025-01-01`
frequency optional	****	Frequency	`WEEKLY`
hour optional	integer	Hour	`9`
max_server_count optional	integer	Max server count	`2`
min_server_count optional	integer	Min server count	`1`
minute optional	integer	Minute	`0`
name optional	string	Schedule name	`schedulename`
start_date optional	string	Start date	`2024-01-01`
state optional	string	Schedule state	`ACTIVE`
timezone optional	string	Timezone	`Asia/Seoul`

3.1.105.3 - 1.0

scpcli virtualserver auto scaling group schedule set
--schedule_id <value>
--auto_scaling_group_id <value>
[--day_of_month <value>]
[--day_of_week <value>]
[--description <value>]
[--desired_server_count <value>]
[--end_date <value>]
[--frequency <value>]
[--hour <value>]
[--max_server_count <value>]
[--min_server_count <value>]
[--minute <value>]
[--name <value>]
[--start_date <value>]
[--state <value>]
[--timezone <value>]

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

Name	Type	Description	Example
schedule_id required	string	Schedule ID	`43d4841abd404220af5f0904037aba71`
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`
day_of_month optional	string	Day of the month	`-1,1`
day_of_week optional	string	Day of the week	`SU,SA`
description optional	string	Description	`description`
desired_server_count optional	integer	Desired server count	`1`
end_date optional	string	End date	`2025-01-01`
frequency optional	****	Frequency	`WEEKLY`
hour optional	integer	Hour	`9`
max_server_count optional	integer	Max server count	`2`
min_server_count optional	integer	Min server count	`1`
minute optional	integer	Minute	`0`
name optional	string	Schedule name	`schedulename`
start_date optional	string	Start date	`2024-01-01`
state optional	string	Schedule state	`ACTIVE`
timezone optional	string	Timezone	`Asia/Seoul`

3.1.106 - Update Auto-Scaling Group server count

3.1.106.1 - 1.2

scpcli virtualserver auto scaling group server count set
--auto_scaling_group_id <value>
[--desired_server_count <value>]
[--max_server_count <value>]
[--min_server_count <value>]

Description

Update Auto-Scaling Group server count.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`
desired_server_count optional	integer	Desired server count	`1`
max_server_count optional	integer	Max server count	`2`
min_server_count optional	integer	Min server count	`1`

3.1.106.2 - 1.1

scpcli virtualserver auto scaling group server count set
--auto_scaling_group_id <value>
[--desired_server_count <value>]
[--max_server_count <value>]
[--min_server_count <value>]

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

Name	Type	Description	Example
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`
desired_server_count optional	integer	Desired server count	`1`
max_server_count optional	integer	Max server count	`2`
min_server_count optional	integer	Min server count	`1`

3.1.106.3 - 1.0

scpcli virtualserver auto scaling group server count set
--auto_scaling_group_id <value>
[--desired_server_count <value>]
[--max_server_count <value>]
[--min_server_count <value>]

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

Name	Type	Description	Example
auto_scaling_group_id required	string	Auto-Scaling Group ID	`52613bd852b04b39adcb15a8364d856d`
desired_server_count optional	integer	Desired server count	`1`
max_server_count optional	integer	Max server count	`2`
min_server_count optional	integer	Min server count	`1`

3.1.107 - Update Image

3.1.107.1 - 1.2

scpcli virtualserver image set
--image_id <value>
[--min_disk <value>]
[--min_ram <value>]
[--protected <value>]
[--visibility <value>]

Description

Update Image.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
image_id required	string	Image ID	`70a599e0-31e7-49b7-b260-868f441e862b`
min_disk optional	integer	Minimum disk capacity (GB) of the Image to be created	`100`
min_ram optional	integer	Minimum RAM capacity (GB) of the Image to be created	`0`
protected optional	boolean	whether Image deletion is prohibited	`False`
visibility optional	string	Indicates access permissions for the Image. Private: Can be used only within the Account, Shared: Can be shared between Accounts	`private`

3.1.107.2 - 1.1

scpcli virtualserver image set
--image_id <value>
[--min_disk <value>]
[--min_ram <value>]
[--protected <value>]
[--visibility <value>]

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

Name	Type	Description	Example
image_id required	string	Image ID	`70a599e0-31e7-49b7-b260-868f441e862b`
min_disk optional	integer	Minimum disk capacity (GB) of the Image to be created	`100`
min_ram optional	integer	Minimum RAM capacity (GB) of the Image to be created	`0`
protected optional	boolean	whether Image deletion is prohibited	`False`
visibility optional	string	Indicates access permissions for the Image. Private: Can be used only within the Account, Shared: Can be shared between Accounts	`private`

3.1.107.3 - 1.0

scpcli virtualserver image set
--image_id <value>
[--min_disk <value>]
[--min_ram <value>]
[--protected <value>]
[--visibility <value>]

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

Name	Type	Description	Example
image_id required	string	Image ID	`70a599e0-31e7-49b7-b260-868f441e862b`
min_disk optional	integer	Minimum disk capacity (GB) of the Image to be created	`100`
min_ram optional	integer	Minimum RAM capacity (GB) of the Image to be created	`0`
protected optional	boolean	whether Image deletion is prohibited	`False`
visibility optional	string	Indicates access permissions for the Image. Private: Can be used only within the Account, Shared: Can be shared between Accounts	`private`

3.1.108 - Update Image member

3.1.108.1 - 1.2

scpcli virtualserver image member set
--member_id <value>
--image_id <value>
--status <value>

Description

Update Image member.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
member_id required	string	Shared Image member ID	`a8f10467abfc4b87b64614ab36eb9ae4`
image_id required	string	Image ID	`70a599e0-31e7-49b7-b260-868f441e862b`
status required	string	Status of this Image member. Value of one of pending, accepted, rejected.	`pending`

3.1.108.2 - 1.1

scpcli virtualserver image member set
--member_id <value>
--image_id <value>
--status <value>

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

Name	Type	Description	Example
member_id required	string	Shared Image member ID	`a8f10467abfc4b87b64614ab36eb9ae4`
image_id required	string	Image ID	`70a599e0-31e7-49b7-b260-868f441e862b`
status required	string	Status of this Image member. Value of one of pending, accepted, rejected.	`pending`

3.1.108.3 - 1.0

scpcli virtualserver image member set
--member_id <value>
--image_id <value>
--status <value>

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

Name	Type	Description	Example
member_id required	string	Shared Image member ID	`a8f10467abfc4b87b64614ab36eb9ae4`
image_id required	string	Image ID	`70a599e0-31e7-49b7-b260-868f441e862b`
status required	string	Status of this Image member. Value of one of pending, accepted, rejected.	`pending`

3.1.109 - Update Server Interface

3.1.109.1 - 1.2

scpcli virtualserver server interface set
--port_id <value>
--server_id <value>
[--fixed_ip_address <value>]
[--subnet_id <value>]

Description

Update Server Interface.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
port_id required	string	Port ID	`91424c08-0b26-49fb-9808-ed042292ceef`
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
fixed_ip_address optional	string	IP address	`192.169.3.2`
subnet_id optional	string	Subnet ID	-

3.1.109.2 - 1.1

scpcli virtualserver server interface set
--port_id <value>
--server_id <value>
[--fixed_ip_address <value>]
[--subnet_id <value>]

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

Name	Type	Description	Example
port_id required	string	Port ID	`91424c08-0b26-49fb-9808-ed042292ceef`
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
fixed_ip_address optional	string	IP address	`192.169.3.2`
subnet_id optional	string	Subnet ID	-

3.1.109.3 - 1.0

scpcli virtualserver server interface set
--port_id <value>
--server_id <value>
[--fixed_ip_address <value>]
[--subnet_id <value>]

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

Name	Type	Description	Example
port_id required	string	Port ID	`91424c08-0b26-49fb-9808-ed042292ceef`
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
fixed_ip_address optional	string	IP address	`192.169.3.2`
subnet_id optional	string	Subnet ID	-

3.1.110 - Update Server Volume

3.1.110.1 - 1.2

scpcli virtualserver server volume set
--volume_id <value>
--server_id <value>
--volume_id <value>
[--delete_on_termination <value>]

Description

Update Server Volume.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
volume_id required	string	Volume ID	`3f500f00-ed80-4566-a057-e31760226f9a`
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
volume_id required	string	Volume ID	`3f500f00-ed80-4566-a057-e31760226f9a`
delete_on_termination optional	boolean	Delete the boot volume when the server is terminated.	`False`

3.1.110.2 - 1.1

scpcli virtualserver server volume set
--volume_id <value>
--server_id <value>
--volume_id <value>
[--delete_on_termination <value>]

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

Name	Type	Description	Example
volume_id required	string	Volume ID	`3f500f00-ed80-4566-a057-e31760226f9a`
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
volume_id required	string	Volume ID	`3f500f00-ed80-4566-a057-e31760226f9a`
delete_on_termination optional	boolean	Delete the boot volume when the server is terminated.	`False`

3.1.110.3 - 1.0

scpcli virtualserver server volume set
--volume_id <value>
--server_id <value>
--volume_id <value>
[--delete_on_termination <value>]

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

Name	Type	Description	Example
volume_id required	string	Volume ID	`3f500f00-ed80-4566-a057-e31760226f9a`
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
volume_id required	string	Volume ID	`3f500f00-ed80-4566-a057-e31760226f9a`
delete_on_termination optional	boolean	Delete the boot volume when the server is terminated.	`False`

3.1.111 - Update Virtual Server

3.1.111.1 - 1.2

scpcli virtualserver server set
--server_id <value>
--name <value>

Description

Update Virtual Server.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
name required	string	Server name	`servername`

3.1.111.2 - 1.1

scpcli virtualserver server set
--server_id <value>
--name <value>

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

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
name required	string	Server name	`servername`

3.1.111.3 - 1.0

scpcli virtualserver server set
--server_id <value>
--name <value>

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

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
name required	string	Server name	`servername`

3.1.112 - Update Virtual Server type

3.1.112.1 - 1.2

scpcli virtualserver server type set
--server_id <value>
--server_type <value>

Description

Update Virtual Server type

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
server_type required	string	Server type	`s1v1m2`

Responses

Name	Description	Example

3.1.112.2 - 1.1

scpcli virtualserver server type set
--server_id <value>
--server_type <value>

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

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
server_type required	string	Server type	`s1v1m2`

Responses

Name	Description	Example

3.1.112.3 - 1.0

scpcli virtualserver server type set
--server_id <value>
--server_type <value>

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

Name	Type	Description	Example
server_id required	string	Server ID	`2a9be312-5d4b-4bc8-b2ae-35100fa9241f`
server_type required	string	Server type	`s1v1m2`

Responses

Name	Description	Example

3.1.113 - Update Volume

3.1.113.1 - 1.2

scpcli virtualserver volume set
--volume_id <value>
[--name <value>]

Description

Update a Volume.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
volume_id required	string	Volume ID	`3f500f00-ed80-4566-a057-e31760226f9a`
name optional	string	Volume name	`volume01`

3.1.113.2 - 1.1

scpcli virtualserver volume set
--volume_id <value>
[--name <value>]

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

Name	Type	Description	Example
volume_id required	string	Volume ID	`3f500f00-ed80-4566-a057-e31760226f9a`
name optional	string	Volume name	`volume01`

3.1.113.3 - 1.0

scpcli virtualserver volume set
--volume_id <value>
[--name <value>]

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

Name	Type	Description	Example
volume_id required	string	Volume ID	`3f500f00-ed80-4566-a057-e31760226f9a`
name optional	string	Volume name	`volume01`