This is the multi-page printable view of this section. Click here to print.
Compute
- 1: Bare Metal Server
- 1.1: APIs
- 1.1.1: Assign Baremetal Private NAT IP
- 1.1.1.1: 1.1
- 1.1.2: Assign Baremetal Public NAT IP
- 1.1.3: Attach Baremetal Local Subnet
- 1.1.4: Create Baremetals
- 1.1.5: Delete Baremetal Private NAT IP
- 1.1.5.1: 1.1
- 1.1.6: Delete Baremetal Public NAT IP
- 1.1.7: Delete Baremetals
- 1.1.8: Detach Baremetal Local Subnet
- 1.1.9: List Baremetal Images
- 1.1.10: List Baremetal Products
- 1.1.11: List Baremetals
- 1.1.12: Lock Baremetal
- 1.1.13: Show Baremetal
- 1.1.14: Start Baremetals
- 1.1.15: Stop Baremetals
- 1.1.16: Unlock Baremetal
- 1.2: Models
- 1.2.1: AsyncResponse
- 1.2.2: BaremetalActionResponse
- 1.2.3: BaremetalCreateRequest
- 1.2.4: BaremetalListResponse
- 1.2.5: BaremetalListResponseV1Dot1
- 1.2.6: BaremetalListV1Dot1
- 1.2.7: BaremetalServerAssignPrivateNatIpRequest
- 1.2.8: BaremetalServerAssignPublicNatIpRequest
- 1.2.9: BaremetalServerIdResponse
- 1.2.10: BaremetalShowResponse
- 1.2.11: BaremetalShowResponseV1Dot1
- 1.2.12: BaremetalsOperationRequest
- 1.2.13: BaremetalStaticNatResponseV1Dot1
- 1.2.14: BaremetalTerminateRequest
- 1.2.15: ImageListResponse
- 1.2.16: ImageShowResponse
- 1.2.17: LocalDiskPartitionsRequest
- 1.2.18: LocalSubnetAttachRequest
- 1.2.19: LocalSubnetDetachRequest
- 1.2.20: LocalSubnetInfoResponse
- 1.2.21: LocalSubnetResponse
- 1.2.22: ProductListResponse
- 1.2.23: ProductListResponseV1Dot1
- 1.2.24: ProductShowResponse
- 1.2.25: ProductShowResponseV1Dot1
- 1.2.26: ServerDetailsRequest
- 1.2.27: TagRequest
- 2: Cloud Functions
- 2.1: APIs
- 2.1.1: Approve PrivateLink Endpoint
- 2.1.2: Check Function Name Duplication
- 2.1.3: Connect PrivateLink Endpoint
- 2.1.4: Create Cloud Function
- 2.1.5: Create Cloud Function Apigateway Trigger
- 2.1.6: Create Cloud Function Cronjob Trigger
- 2.1.7: Create PrivateLink Endpoint
- 2.1.8: Delete Cloud Function
- 2.1.9: Delete Cloud Function Trigger
- 2.1.10: Delete PrivateLink Endpoint
- 2.1.11: Delete Resource Policy
- 2.1.11.1: 1.3
- 2.1.12: List Cloud Function Triggers
- 2.1.13: List Cloud Functions
- 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.17: List Sample Codes
- 2.1.18: Request PrivateLink Endpoint
- 2.1.19: Set Resource Policy
- 2.1.19.1: 1.3
- 2.1.20: Show Cloud Function
- 2.1.21: Show Cloud Function Code
- 2.1.22: Show Cloud Function Configuration
- 2.1.23: Show Cloud Function Logs
- 2.1.24: Show Cloud Function Metrics
- 2.1.25: Show Cloud Function Trigger
- 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.31: Update Cloud Function Code File
- 2.1.32: Update Cloud Function Config
- 2.1.33: Update Cloud Function Cronjob Trigger
- 2.1.34: Update Cloud Function Url
- 2.1.35: Update Cloud Function Variables
- 2.1.36: Update PrivateLink Service
- 2.2: Models
- 2.2.1: ApigatewayTriggerCreateRequest
- 2.2.2: CloudFunction
- 2.2.3: CloudFunctionCreateRequest
- 2.2.4: CloudFunctionCreateResponse
- 2.2.5: CloudFunctionForList
- 2.2.6: CloudFunctionListResponse
- 2.2.7: CloudFunctionShowResponse
- 2.2.8: Code
- 2.2.9: CodeFile
- 2.2.10: CodeSetRequest
- 2.2.11: Configuration
- 2.2.12: ConfigurationV1Dot2
- 2.2.13: CronjobTriggerCreateRequest
- 2.2.14: CronjobTriggerSetRequest
- 2.2.15: DuplicationShowResponse
- 2.2.16: Endpoint
- 2.2.17: EndpointCreateRequest
- 2.2.18: FunctionConfig
- 2.2.19: FunctionUrl
- 2.2.20: FunctionUrlRequest
- 2.2.21: FunctionUrlV1Dot3
- 2.2.22: FunctionVariable
- 2.2.23: FunctionVariables
- 2.2.24: Log
- 2.2.25: LogShowResponse
- 2.2.26: Metric
- 2.2.27: MetricShowResponse
- 2.2.28: PolicyDocument
- 2.2.29: PrivateLinkEndpoint
- 2.2.30: PrivateLinkEndpointApproval
- 2.2.31: PrivateLinkEndpointConnection
- 2.2.32: PrivateLinkEndpointCreateRequest
- 2.2.33: PrivateLinkEndpointList
- 2.2.34: PrivateLinkEndpointRequest
- 2.2.35: PrivateLinkService
- 2.2.36: PrivateLinkServicePutRequest
- 2.2.37: PrivateLinkServiceV1Dot3
- 2.2.38: ResourcePolicySetRequest
- 2.2.39: ResourcePolicyShowResponse
- 2.2.40: Runtime
- 2.2.41: RuntimeListResponse
- 2.2.42: SampleCode
- 2.2.43: SampleCodesListResponse
- 2.2.44: Statement
- 2.2.45: Tag
- 2.2.46: Trigger
- 2.2.47: TriggerCreateResponse
- 2.2.48: TriggerDeleteRequest
- 2.2.49: TriggerForList
- 2.2.50: TriggersResponse
- 2.2.51: TriggerUpdateResponse
- 3: Multi-node GPU Cluster
- 3.1: APIs
- 3.1.1: Assign GpuNode Public NAT IP
- 3.1.1.1: 1.2
- 3.1.2: Create GPU Nodes
- 3.1.2.1: 1.2
- 3.1.3: Delete GPU Nodes
- 3.1.3.1: 1.2
- 3.1.4: List Cluster Fabrics
- 3.1.4.1: 1.2
- 3.1.5: List GPU Node Images
- 3.1.5.1: 1.2
- 3.1.6: List GPU Node Products
- 3.1.6.1: 1.2
- 3.1.7: List GPU Nodes
- 3.1.7.1: 1.2
- 3.1.8: List Node Pools
- 3.1.8.1: 1.2
- 3.1.9: Lock GPU Node
- 3.1.9.1: 1.2
- 3.1.10: Modify Cluster Fabric Members
- 3.1.10.1: 1.2
- 3.1.11: Release GPU Node Public NAT IP
- 3.1.11.1: 1.2
- 3.1.12: Show Cluster Fabric
- 3.1.12.1: 1.2
- 3.1.13: Show GPU Node
- 3.1.13.1: 1.2
- 3.1.14: Start GPU Nodes
- 3.1.14.1: 1.2
- 3.1.15: Stop GPU Nodes
- 3.1.15.1: 1.2
- 3.1.16: Unlock GPU Node
- 3.1.16.1: 1.2
- 3.2: Models
- 3.2.1: AsyncResponse
- 3.2.2: ClusterFabricDetailsRequest
- 3.2.3: ClusterFabricDetailsResponse
- 3.2.4: ClusterFabricListResponse
- 3.2.5: ClusterFabricMemberModifyRequestBody
- 3.2.6: ClusterFabricShowResponse
- 3.2.7: GpuNodeActionResponse
- 3.2.8: GpuNodeAssignPublicNatIpRequest
- 3.2.9: GpuNodeCreateRequest
- 3.2.10: GpuNodeDetailsRequest
- 3.2.11: GpuNodeDetailsResponse
- 3.2.12: GpuNodeImageListResponse
- 3.2.13: GpuNodeImageShowResponse
- 3.2.14: GpuNodeListResponse
- 3.2.15: GpuNodeOperationRequest
- 3.2.16: GpuNodeProductAttr
- 3.2.17: GpuNodeProductListResponse
- 3.2.18: GpuNodeProductShowResponse
- 3.2.19: GpuNodeShowResponse
- 3.2.20: GpuNodeTerminateRequest
- 3.2.21: NodePoolListResponse
- 3.2.22: NodePoolShowResponse
- 3.2.23: Tag
- 4: Virtual Server
- 4.1: APIs
- 4.1.1: Accept a volume transfer
- 4.1.2: Attach Virtual Server Security Group
- 4.1.2.1: 1.0
- 4.1.3: Attach Volume to Virtual Server
- 4.1.4: Create a snapshot
- 4.1.5: Create a volume transfer
- 4.1.6: Create Auto-Scaling Group
- 4.1.7: Create Auto-Scaling Group Notification
- 4.1.8: Create Auto-Scaling Group Policy
- 4.1.9: Create Auto-Scaling Group Schedule
- 4.1.10: Create Image
- 4.1.11: Create Image member
- 4.1.12: Create Keypair
- 4.1.13: Create Launch Configuration
- 4.1.14: Create Server Group
- 4.1.15: Create Server Interface
- 4.1.16: Create Server Interface Nat
- 4.1.17: Create Server Interface Private Nat
- 4.1.18: Create Server Volume
- 4.1.19: Create Sharing Image
- 4.1.20: Create Virtual Server
- 4.1.21: Create Virtual Server Custom Image
- 4.1.22: Create Virtual Server Dump
- 4.1.23: Create Volume
- 4.1.24: Delete a snapshot
- 4.1.25: Delete a volume transfer
- 4.1.26: Delete Auto-Scaling Group
- 4.1.27: Delete Auto-Scaling Group Notification
- 4.1.28: Delete Auto-Scaling Group Policy
- 4.1.29: Delete Auto-Scaling Group Schedule
- 4.1.30: Delete Image
- 4.1.31: Delete Image member
- 4.1.32: Delete Keypair
- 4.1.33: Delete Launch Configuration
- 4.1.34: Delete Server Group
- 4.1.35: Delete Server Interface
- 4.1.36: Delete Server Interface Nat
- 4.1.37: Delete Server Interface Private Nat
- 4.1.38: Delete Server Volume
- 4.1.39: Delete Virtual Server
- 4.1.40: Delete Volume
- 4.1.41: Detach Virtual Server Security Group
- 4.1.41.1: 1.0
- 4.1.42: Detach Volume from Virtual Server
- 4.1.43: Extend Volume
- 4.1.44: Get region's maximum partition size.
- 4.1.45: Import Image
- 4.1.46: List Auto-Scaling Group LB Server Groups
- 4.1.47: List Auto-Scaling Group Notifications
- 4.1.48: List Auto-Scaling Group Policies
- 4.1.49: List Auto-Scaling Group Schedules
- 4.1.50: List Auto-Scaling Group Virtual Servers
- 4.1.51: List Auto-Scaling Groups
- 4.1.52: List Default Configs
- 4.1.53: List Image members
- 4.1.54: List Images
- 4.1.55: List Keypairs
- 4.1.56: List Launch Configurations
- 4.1.57: List pending Images
- 4.1.58: List Server Groups
- 4.1.59: List Server Interfaces
- 4.1.60: List Server Ips
- 4.1.61: List Server Types
- 4.1.62: List Server Volumes
- 4.1.63: List snapshots
- 4.1.64: List Virtual Server Security Group
- 4.1.65: List Virtual Servers
- 4.1.66: List volume transfers
- 4.1.67: List volume types
- 4.1.68: List volumes
- 4.1.69: Lock Virtual Server
- 4.1.70: Reboot Virtual Server
- 4.1.71: Rebuild Virtual Server
- 4.1.72: Revert Volume to snapshot
- 4.1.73: Set Volume Qos
- 4.1.73.1: 1.2
- 4.1.74: Show a snapshot’s details
- 4.1.75: Show Auto-Scaling Group
- 4.1.76: Show Auto-Scaling Group Notification
- 4.1.77: Show Auto-Scaling Group Policy
- 4.1.78: Show Auto-Scaling Group Schedule
- 4.1.79: Show default Volume type’s details
- 4.1.80: Show Image
- 4.1.81: Show Image member
- 4.1.82: Show Keypair
- 4.1.83: Show Launch Configuration
- 4.1.84: Show Server Group
- 4.1.85: Show Server Interface
- 4.1.86: Show Server Ip
- 4.1.87: Show Server Quota Set
- 4.1.88: Show Server Type
- 4.1.89: Show Server Volume
- 4.1.90: Show Virtual Server
- 4.1.91: Show Virtual Server Console Log
- 4.1.92: Show Virtual Server Password
- 4.1.93: Show Volume Quota Set
- 4.1.94: Show volume transfer detail
- 4.1.95: Show Volume type’s details
- 4.1.96: Show Volume's details
- 4.1.97: Start Virtual Server
- 4.1.98: Stop Virtual Server
- 4.1.99: Unlock Virtual Server
- 4.1.100: Update a snapshot
- 4.1.101: Update Auto-Scaling Group
- 4.1.102: Update Auto-Scaling Group LB Server Groups
- 4.1.103: Update Auto-Scaling Group Notification
- 4.1.104: Update Auto-Scaling Group Policy
- 4.1.105: Update Auto-Scaling Group Schedule
- 4.1.106: Update Auto-Scaling Group server count
- 4.1.107: Update Image
- 4.1.108: Update Image member
- 4.1.109: Update Server Interface
- 4.1.110: Update Server Volume
- 4.1.111: Update Virtual Server
- 4.1.112: Update Virtual Server type
- 4.1.113: Update Volume
- 4.2: Models
- 4.2.1: AutoScalingGroup
- 4.2.2: AutoScalingGroupCreateRequest
- 4.2.3: AutoScalingGroupCreateRequestV1Dot2
- 4.2.4: AutoScalingGroupLbServerGroup
- 4.2.5: AutoScalingGroupLbServerGroupListResponse
- 4.2.6: AutoScalingGroupLbServerGroupSetRequest
- 4.2.7: AutoScalingGroupLbServerGroupShowResponse
- 4.2.8: AutoScalingGroupListResponse
- 4.2.9: AutoScalingGroupListResponseV1Dot2
- 4.2.10: AutoScalingGroupNotificationCreateRequest
- 4.2.11: AutoScalingGroupNotificationListResponse
- 4.2.12: AutoScalingGroupNotificationShowResponse
- 4.2.13: AutoScalingGroupNotificationUpdateRequest
- 4.2.14: AutoScalingGroupPolicyCreateRequest
- 4.2.15: AutoScalingGroupPolicyListResponse
- 4.2.16: AutoScalingGroupPolicyShowResponse
- 4.2.17: AutoScalingGroupPolicyUpdateRequest
- 4.2.18: AutoScalingGroupPolicyUpdateRequestV1Dot2
- 4.2.19: AutoScalingGroupScheduleCreateRequest
- 4.2.20: AutoScalingGroupScheduleListResponse
- 4.2.21: AutoScalingGroupScheduleShowResponse
- 4.2.22: AutoScalingGroupScheduleUpdateRequest
- 4.2.23: AutoScalingGroupSetRequest
- 4.2.24: AutoScalingGroupSetRequestV1Dot2
- 4.2.25: AutoScalingGroupSetServerCountRequest
- 4.2.26: AutoScalingGroupShowResponse
- 4.2.27: AutoScalingGroupShowResponseV1Dot2
- 4.2.28: AutoScalingGroupV1Dot2
- 4.2.29: AutoScalingGroupVirtualServerListResponse
- 4.2.30: AutoScalingGroupVirtualServerListResponseV1Dot2
- 4.2.31: AutoScalingGroupVirtualServerShowResponse
- 4.2.32: AutoScalingGroupVirtualServerShowResponseV1Dot2
- 4.2.33: DefaultConfigListResponse
- 4.2.34: ImageCreateRequest
- 4.2.35: ImageImportRequest
- 4.2.36: ImageListResponse
- 4.2.37: ImageListResponseV1Dot2
- 4.2.38: ImageMemberCreateRequest
- 4.2.39: ImageMemberListResponse
- 4.2.40: ImageMemberSetRequest
- 4.2.41: ImageMemberShowResponse
- 4.2.42: ImageSetRequest
- 4.2.43: ImageShowResponse
- 4.2.44: ImageShowResponseV1Dot2
- 4.2.45: InterfaceAttachmentFixedIp
- 4.2.46: InterfaceResponse
- 4.2.47: InterfaceResponseV1Dot2
- 4.2.48: Keypair
- 4.2.49: KeypairCreateRequest
- 4.2.50: KeypairCreateResponse
- 4.2.51: KeypairListResponse
- 4.2.52: KeypairShowResponse
- 4.2.53: LaunchConfigurationCreateRequest
- 4.2.54: LaunchConfigurationDetailShowResponse
- 4.2.55: LaunchConfigurationDetailShowResponseV1Dot2
- 4.2.56: LaunchConfigurationListResponse
- 4.2.57: LaunchConfigurationListResponseV1Dot2
- 4.2.58: LaunchConfigurationShowResponse
- 4.2.59: LaunchConfigurationShowResponseV1Dot2
- 4.2.60: LaunchConfigurationVolume
- 4.2.61: LaunchConfigurationVolumeV1Dot2
- 4.2.62: Network
- 4.2.63: PrivateStaticNat
- 4.2.64: PublicStaticNat
- 4.2.65: SecurityGroupResponse
- 4.2.66: SecurityGroupResponseRule
- 4.2.67: SecurityGroupResponseRuleIpRange
- 4.2.68: ServerConsoleLogResponse
- 4.2.69: ServerCreateImageRequestBody
- 4.2.70: ServerCreateImageResponse
- 4.2.71: ServerCreateRequest
- 4.2.72: ServerCreateRequestV1Dot2
- 4.2.73: ServerCreateResponse
- 4.2.74: ServerCreateResponseParam
- 4.2.75: ServerGroup
- 4.2.76: ServerGroupCreateRequest
- 4.2.77: ServerGroupListResponse
- 4.2.78: ServerGroupPartitionSizeResponse
- 4.2.79: ServerInterfaceCreateRequest
- 4.2.80: ServerInterfaceListResponse
- 4.2.81: ServerInterfaceListResponseV1Dot2
- 4.2.82: ServerInterfaceUpdateRequest
- 4.2.83: ServerIpsResponse
- 4.2.84: ServerListResponse
- 4.2.85: ServerPasswordRequest
- 4.2.86: ServerPasswordResponse
- 4.2.87: ServerPrivateStaticNatCreateRequest
- 4.2.88: ServerQuotaSet
- 4.2.89: ServerQuotaSetObject
- 4.2.90: ServerRebootRequestBody
- 4.2.91: ServerSecurityGroupActionRequestBody
- 4.2.92: ServerSecurityGroupListResponse
- 4.2.93: ServerSetServerTypeRequestBody
- 4.2.94: ServerShowResponse
- 4.2.95: ServerShowResponseAddress
- 4.2.96: ServerShowResponseAddressIpAddress
- 4.2.97: ServerShowResponseSecurityGroup
- 4.2.98: ServerShowResponseServerType
- 4.2.99: ServerShowResponseVolume
- 4.2.100: ServerStaticNatCreateRequest
- 4.2.101: ServersVolumeResponse
- 4.2.102: ServerType
- 4.2.103: ServerTypeListResponse
- 4.2.104: ServerUpdateRequest
- 4.2.105: ServerVolumesCreateRequest
- 4.2.106: ServerVolumesResponse
- 4.2.107: ServerVolumesUpdateRequest
- 4.2.108: SnapshotCreateRequest
- 4.2.109: SnapshotDetailResponse
- 4.2.110: SnapshotListResponse
- 4.2.111: SnapshotUpdateRequest
- 4.2.112: Tag
- 4.2.113: Volume
- 4.2.114: VolumeCreateRequest
- 4.2.115: VolumeCreateRequestV1Dot2
- 4.2.116: VolumeExtendRequest
- 4.2.117: VolumeImageMetadataResponse
- 4.2.118: VolumeListResponse
- 4.2.119: VolumeListResponseV1Dot2
- 4.2.120: VolumeQuotaSet
- 4.2.121: VolumeQuotaSetObject
- 4.2.122: VolumeRevertRequest
- 4.2.123: VolumeServer
- 4.2.124: VolumeServerAttachRequest
- 4.2.125: VolumeServerAttachResponse
- 4.2.126: VolumeSetQosRequest
- 4.2.127: VolumeShowResponse
- 4.2.128: VolumeShowResponseV1Dot2
- 4.2.129: VolumeTransferAcceptRequest
- 4.2.130: VolumeTransferAcceptResponse
- 4.2.131: VolumeTransferCreateResponse
- 4.2.132: VolumeTransferListResponse
- 4.2.133: VolumeTransferRequest
- 4.2.134: VolumeTransferShowResponse
- 4.2.135: VolumeTypeDetailResponse
- 4.2.136: VolumeTypeExtraSpecs
- 4.2.137: VolumeTypeListResponse
- 4.2.138: VolumeUpdateRequest
- 4.2.139: VolumeV1Dot2
1 - Bare Metal Server
Overview
Provides an Application Programming Interface (API) that supports programmatic use of IaaS/PaaS products provided by SCP.
This guide provides a brief description of Bare Metal Server service and how to call API. The API is provided as a RESTful API, and it responds in JSON format.
Version
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Status | Not Before |
|---|---|---|
| 1.1 | CURRENT | - |
| 1.0 | DEPRECATED | 20251231 |
OpenAPI URL
https://baremetal.{region}.{environment}.samsungsdscloud.com
Environment and Region List
| environment | region |
|---|---|
| s | kr-west1 |
| s | kr-east1 |
| g | kr-south1 |
| g | kr-south2 |
| g | kr-south3 |
| e | kr-west1 |
| e | kr-east1 |
1.1 - APIs
1.1.1 - Assign Baremetal Private NAT IP
1.1.1.1 - 1.1
post /v1/baremetals/{baremetal_id}/private-nat-ips
Description
Assign Private NAT IP at Bare Metal Server.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | baremetal_id required | Bare Metal Server ID Example : 20c507a036c447cdb3b19468d8ea62ac | string | None |
| body | body required | BaremetalServerAssignPrivateNatIpRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | BaremetalStaticNatResponseV1Dot1 |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/baremetals/{baremetal_id}/private-nat-ips
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal 1.1"
Request body
{
"private_nat_id": "a4fd0216cd32442a82733bbb8be0e82b",
"private_nat_ip_id": "03cd065d8acc4e47b11a11dc1411323e"
}
Example HTTP response
Response 202
{
"nat_id": "a4fd0216cd32442a82733bbb8be0e82b",
"nat_ip": "192.170.2.10",
"nat_ip_id": "20c507a036c447cdb3b19468d8ea62ac",
"state": "ACTIVE",
"static_nat_id": "a1b97ae4695b40b0866e86a19cb191d3"
}
1.1.2 - Assign Baremetal Public NAT IP
1.1.2.1 - 1.1
post /v1/baremetals/{baremetal_id}/public-nat-ips
Description
Assign Public NAT IP at Bare Metal Server.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | baremetal_id required | Bare Metal Server ID Example : 20c507a036c447cdb3b19468d8ea62ac | string | None |
| body | body required | BaremetalServerAssignPublicNatIpRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | BaremetalServerIdResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/baremetals/{baremetal_id}/public-nat-ips
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal 1.1"
Request body
{
"public_ip_address_id": "20c507a036c447cdb3b19468d8ea62ac"
}
Example HTTP response
Response 202
{
"baremetal_id": "20c507a036c447cdb3b19468d8ea62ac"
}
1.1.2.2 - 1.0
post /v1/baremetals/{baremetal_id}/public-nat-ips
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | baremetal_id required | Bare Metal Server ID Example : 20c507a036c447cdb3b19468d8ea62ac | string | None |
| body | body required | BaremetalServerAssignPublicNatIpRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | BaremetalServerIdResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/baremetals/{baremetal_id}/public-nat-ips
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal 1.0"
Request body
{
"public_ip_address_id": "20c507a036c447cdb3b19468d8ea62ac"
}
Example HTTP response
Response 202
{
"baremetal_id": "20c507a036c447cdb3b19468d8ea62ac"
}
1.1.3 - Attach Baremetal Local Subnet
1.1.3.1 - 1.1
put /v1/baremetals/local-subnet/{baremetal_id}/attach
Description
Attach Local Subnet for Bare Metal Server.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | baremetal_id required | Bare Metal Server ID Example : 20c507a036c447cdb3b19468d8ea62ac | string | None |
| body | body required | LocalSubnetAttachRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | LocalSubnetResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/baremetals/local-subnet/{baremetal_id}/attach
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal 1.1"
Request body
{
"local_subnet_id": "ab313c43291e4b678f4bacffe10768ae",
"local_subnet_ip": "192.168.0.1"
}
Example HTTP response
Response 202
{
"baremetal_id": "20c507a036c447cdb3b19468d8ea62ac",
"is_success": true
}
1.1.3.2 - 1.0
put /v1/baremetals/local-subnet/{baremetal_id}/attach
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | baremetal_id required | Bare Metal Server ID Example : 20c507a036c447cdb3b19468d8ea62ac | string | None |
| body | body required | LocalSubnetAttachRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | LocalSubnetResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/baremetals/local-subnet/{baremetal_id}/attach
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal 1.0"
Request body
{
"local_subnet_id": "ab313c43291e4b678f4bacffe10768ae",
"local_subnet_ip": "192.168.0.1"
}
Example HTTP response
Response 202
{
"baremetal_id": "20c507a036c447cdb3b19468d8ea62ac",
"is_success": true
}
1.1.4 - Create Baremetals
1.1.4.1 - 1.1
post /v1/baremetals
Description
Create Bare Metal Servers.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | BaremetalCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | AsyncResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/baremetals
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal 1.1"
Request body
{
"image_id": "IMAGE-7XFMaJpLsapKvskFMjCtmm",
"init_script": "init script",
"lock_enabled": true,
"os_user_id": "user001",
"os_user_password": "password",
"placement_group_name": "pgtest",
"region_id": "kr-west1",
"server_details": [
{
"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
}
],
"subnet_id": "ab313c43291e4b678f4bacffe10768ae",
"tags": [
{
"key": "key",
"value": "value"
}
],
"use_placement_group": false,
"vpc_id": "e58348b1bc9148e5af86500fd4ef99ca"
}
Example HTTP response
Response 202
{
"account_id": "f5c8e56a4d9b49a8bd89e14758a32d53",
"request_id": "req-002daa83-52d9-41e8-9b0f-d31d35610f65",
"resource_id": "20c507a036c447cdb3b19468d8ea62ac"
}
1.1.4.2 - 1.0
post /v1/baremetals
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | BaremetalCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | AsyncResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/baremetals
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal 1.0"
Request body
{
"image_id": "IMAGE-7XFMaJpLsapKvskFMjCtmm",
"init_script": "init script",
"lock_enabled": true,
"os_user_id": "user001",
"os_user_password": "password",
"placement_group_name": "pgtest",
"region_id": "kr-west1",
"server_details": [
{
"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
}
],
"subnet_id": "ab313c43291e4b678f4bacffe10768ae",
"tags": [
{
"key": "key",
"value": "value"
}
],
"use_placement_group": false,
"vpc_id": "e58348b1bc9148e5af86500fd4ef99ca"
}
Example HTTP response
Response 202
{
"account_id": "f5c8e56a4d9b49a8bd89e14758a32d53",
"request_id": "req-002daa83-52d9-41e8-9b0f-d31d35610f65",
"resource_id": "20c507a036c447cdb3b19468d8ea62ac"
}
1.1.5 - Delete Baremetal Private NAT IP
1.1.5.1 - 1.1
delete /v1/baremetals/{baremetal_id}/private-nat-ips
Description
Delete Private NAT IP Bare Metal Server.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | baremetal_id required | Bare Metal Server ID Example : 20c507a036c447cdb3b19468d8ea62ac | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | BaremetalStaticNatResponseV1Dot1 |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/baremetals/{baremetal_id}/private-nat-ips
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal 1.1"
Example HTTP response
Response 202
{
"nat_id": "a4fd0216cd32442a82733bbb8be0e82b",
"nat_ip": "192.170.2.10",
"nat_ip_id": "20c507a036c447cdb3b19468d8ea62ac",
"state": "ACTIVE",
"static_nat_id": "a1b97ae4695b40b0866e86a19cb191d3"
}
1.1.6 - Delete Baremetal Public NAT IP
1.1.6.1 - 1.1
delete /v1/baremetals/{baremetal_id}/public-nat-ips
Description
Delete Public NAT IP Bare Metal Server.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | baremetal_id required | Bare Metal Server ID Example : 20c507a036c447cdb3b19468d8ea62ac | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | BaremetalServerIdResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/baremetals/{baremetal_id}/public-nat-ips
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal 1.1"
Example HTTP response
Response 202
{
"baremetal_id": "20c507a036c447cdb3b19468d8ea62ac"
}
1.1.6.2 - 1.0
delete /v1/baremetals/{baremetal_id}/public-nat-ips
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | baremetal_id required | Bare Metal Server ID Example : 20c507a036c447cdb3b19468d8ea62ac | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | BaremetalServerIdResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/baremetals/{baremetal_id}/public-nat-ips
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal 1.0"
Example HTTP response
Response 202
{
"baremetal_id": "20c507a036c447cdb3b19468d8ea62ac"
}
1.1.7 - Delete Baremetals
1.1.7.1 - 1.1
delete /v1/baremetals
Description
Delete Bare Metal Servers.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | BaremetalTerminateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | AsyncResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/baremetals
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal 1.1"
Request body
{
"baremetal_id_list": [
"20c507a036c447cdb3b19468d8ea62ac"
]
}
Example HTTP response
Response 202
{
"account_id": "f5c8e56a4d9b49a8bd89e14758a32d53",
"request_id": "req-002daa83-52d9-41e8-9b0f-d31d35610f65",
"resource_id": "20c507a036c447cdb3b19468d8ea62ac"
}
1.1.7.2 - 1.0
delete /v1/baremetals
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | BaremetalTerminateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | AsyncResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/baremetals
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal 1.0"
Request body
{
"baremetal_id_list": [
"20c507a036c447cdb3b19468d8ea62ac"
]
}
Example HTTP response
Response 202
{
"account_id": "f5c8e56a4d9b49a8bd89e14758a32d53",
"request_id": "req-002daa83-52d9-41e8-9b0f-d31d35610f65",
"resource_id": "20c507a036c447cdb3b19468d8ea62ac"
}
1.1.8 - Detach Baremetal Local Subnet
1.1.8.1 - 1.1
put /v1/baremetals/local-subnet/{baremetal_id}/detach
Description
Detach Local Subnet for Bare Metal Server.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | baremetal_id required | Bare Metal Server ID Example : 20c507a036c447cdb3b19468d8ea62ac | string | None |
| body | body required | LocalSubnetDetachRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | LocalSubnetResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/baremetals/local-subnet/{baremetal_id}/detach
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal 1.1"
Request body
{
"local_subnet_id": "ab313c43291e4b678f4bacffe10768ae",
"local_subnet_ip": "192.168.0.1"
}
Example HTTP response
Response 202
{
"baremetal_id": "20c507a036c447cdb3b19468d8ea62ac",
"is_success": true
}
1.1.8.2 - 1.0
put /v1/baremetals/local-subnet/{baremetal_id}/detach
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | baremetal_id required | Bare Metal Server ID Example : 20c507a036c447cdb3b19468d8ea62ac | string | None |
| body | body required | LocalSubnetDetachRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | LocalSubnetResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/baremetals/local-subnet/{baremetal_id}/detach
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal 1.0"
Request body
{
"local_subnet_id": "ab313c43291e4b678f4bacffe10768ae",
"local_subnet_ip": "192.168.0.1"
}
Example HTTP response
Response 202
{
"baremetal_id": "20c507a036c447cdb3b19468d8ea62ac",
"is_success": true
}
1.1.9 - List Baremetal Images
1.1.9.1 - 1.1
get /v1/images
Description
List Bare Metal Server Images.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | region_id required | Region ID Example : kr-west1 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ImageListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/images?region_id={region_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal 1.1"
Example HTTP response
Response 200
{
"images": [
{
"created_at": "2024-07-11 08:56:59",
"id": "IMAGE-7XFMaJpLsapKvskFMjCtmm",
"name": "RHEL 8.8 for BM",
"os_distro": "RHEL",
"scp_image_type": "STANDARD",
"scp_os_version": "8.7"
}
]
}
1.1.9.2 - 1.0
get /v1/images
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | region_id required | Region ID Example : kr-west1 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ImageListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/images?region_id={region_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal 1.0"
Example HTTP response
Response 200
{
"images": [
{
"created_at": "2024-07-11 08:56:59",
"id": "IMAGE-7XFMaJpLsapKvskFMjCtmm",
"name": "RHEL 8.8 for BM",
"os_distro": "RHEL",
"scp_image_type": "STANDARD",
"scp_os_version": "8.7"
}
]
}
1.1.10 - List Baremetal Products
1.1.10.1 - 1.1
get /v1/bm_products
Description
List Bare Metal Server products.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | image_id optional | Image ID Example : IMAGE-7XFMaJpLsapKvskFMjCtmm | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ProductListResponseV1Dot1 |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/bm_products
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal 1.1"
Example HTTP response
Response 200
{
"products": [
{
"compute_class_type_name": "StandardMetal-2",
"compute_class_type_value": "s2_metal",
"cpu_name": "cpu 16 vCore",
"cpu_unit": "vCPU",
"cpu_value": "64",
"created_at": "2024-05-17T00:23:17Z",
"description": "vCPU 16 │ Memory 128G │ Disk 480G",
"disk_unit": "GB",
"disk_value": "480",
"id": "PRODUCT-0iT9dNiLr4lVoYmjlY2Vgg",
"memory_name": "server memory 128GB",
"memory_unit": "GB",
"memory_value": "128",
"modified_at": "2024-05-17T00:23:17Z",
"name": "s2v16m128_metal",
"name_with_generation": "s2v16m128_metal",
"os_disk_gb": "480",
"state": "AVAILABLE",
"type": "SCALE"
}
]
}
1.1.10.2 - 1.0
get /v1/bm_products
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | image_id optional | Image ID Example : IMAGE-7XFMaJpLsapKvskFMjCtmm | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ProductListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/bm_products
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal 1.0"
Example HTTP response
Response 200
{
"products": [
{
"attri_name": "attri name",
"attri_value": "attri value",
"compute_class_type_name": "StandardMetal-2",
"compute_class_type_unit": "compute_class_type_unit",
"compute_class_type_value": "s2_metal",
"cpu_generation": "cpu generation",
"cpu_name": "cpu 16 vCore",
"cpu_unit": "vCPU",
"cpu_value": "64",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "vCPU 16 │ Memory 128G │ Disk 480G",
"disk_name": "disk_name",
"disk_unit": "GB",
"disk_value": "480",
"id": "PRODUCT-0iT9dNiLr4lVoYmjlY2Vgg",
"infiniband_name": "infiniband_name",
"infiniband_unit": "infiniband_unit",
"infiniband_value": "infiniband_value",
"memory_name": "server memory 128GB",
"memory_unit": "GB",
"memory_value": "128",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "s2v16m128_metal",
"name_with_generation": "s2v16m128_metal",
"socket_name": "socket_name",
"socket_unit": "socket_unit",
"socket_value": "socket_value",
"state": "AVAILABLE",
"type": "SCALE"
}
]
}
1.1.11 - List Baremetals
1.1.11.1 - 1.1
get /v1/baremetals
Description
Get Bare Metal Servers list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | server_name optional | Bare Metal Server name Example : bmserver-001 | any of [string, null] | None |
| query | state optional | Bare Metal Server state Example : RUNNING | any of [string, null] | None |
| query | ip optional | Bare Metal Server IP address Example : 192.168.0.1 | any of [string, null] | None |
| query | vpc_id optional | VPC ID Example : e58348b1bc9148e5af86500fd4ef99ca | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | BaremetalListResponseV1Dot1 |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/baremetals
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal 1.1"
Example HTTP response
Response 200
{
"baremetals": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"image_id": "IMAGE-7XFMaJpLsapKvskFMjCtmm",
"image_version": "RHEL 8.7 for BM",
"lock_enabled": true,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"network_id": "ab313c43291e4b678f4bacffe10768ae",
"os_type": "WINDOWS",
"placement_group_name": "pgtest",
"policy_ip": "192.168.0.1",
"product_type_id": "PRODUCT-0iT9dNiLr4lVoYmjlY2Vgg",
"region_id": "kr-west1",
"server_name": "bmserver-001",
"server_type": "s1v8m32_metal",
"state": "RUNNING",
"vpc_id": "e58348b1bc9148e5af86500fd4ef99ca"
}
],
"count": 20
}
1.1.11.2 - 1.0
get /v1/baremetals
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | server_name optional | Bare Metal Server name Example : bmserver-001 | any of [string, null] | None |
| query | state optional | Bare Metal Server state Example : RUNNING | any of [string, null] | None |
| query | ip optional | Bare Metal Server IP address Example : 192.168.0.1 | any of [string, null] | None |
| query | vpc_id optional | VPC ID Example : e58348b1bc9148e5af86500fd4ef99ca | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | BaremetalListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/baremetals
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal 1.0"
Example HTTP response
Response 200
{
"baremetals": [
{
"account_id": "f5c8e56a4d9b49a8bd89e14758a32d53",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "ef716e80-1fac-4faa-892d-0132fc7f5583",
"hyper_threading_use": true,
"id": "20c507a036c447cdb3b19468d8ea62ac",
"image_id": "IMAGE-7XFMaJpLsapKvskFMjCtmm",
"image_version": "RHEL 8.7 for BM",
"init_script": "init script",
"local_subnet_info": [
{
"interface_name": "ens8f1,bond_serv.2",
"local_subnet_id": "ab313c43291e4b678f4bacffe10768ae",
"policy_local_subnet_ip": "192.168.0.1",
"state": "CREATING",
"vlan_id": 500,
"vni_role_name": "mgmtJ4dzQBo"
}
],
"lock_enabled": true,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "ef716e80-1fac-4faa-892d-0132fc7f5583",
"network_id": "ab313c43291e4b678f4bacffe10768ae",
"os_type": "WINDOWS",
"placement_group_name": "pgtest",
"policy_ip": "192.168.0.1",
"policy_nat": "192.168.0.1",
"policy_use_nat": true,
"product_type_id": "PRODUCT-0iT9dNiLr4lVoYmjlY2Vgg",
"public_nat_status": "ACTIVE",
"region_id": "kr-west1",
"root_account": "rootaccount",
"server_name": "bmserver-001",
"server_type": "s1v8m32_metal",
"state": "RUNNING",
"time_zone": "Asia/Seoul",
"use_local_subnet": true,
"vpc_id": "e58348b1bc9148e5af86500fd4ef99ca"
}
],
"count": 20
}
1.1.12 - Lock Baremetal
1.1.12.1 - 1.1
put /v1/baremetals/{baremetal_id}/lock
Description
Lock Bare Metal Server.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | baremetal_id required | Bare Metal Server ID Example : 20c507a036c447cdb3b19468d8ea62ac | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | BaremetalActionResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/baremetals/{baremetal_id}/lock
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal 1.1"
Example HTTP response
Response 200
{
"baremetal_id": "20c507a036c447cdb3b19468d8ea62ac"
}
1.1.12.2 - 1.0
put /v1/baremetals/{baremetal_id}/lock
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | baremetal_id required | Bare Metal Server ID Example : 20c507a036c447cdb3b19468d8ea62ac | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | BaremetalActionResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/baremetals/{baremetal_id}/lock
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal 1.0"
Example HTTP response
Response 200
{
"baremetal_id": "20c507a036c447cdb3b19468d8ea62ac"
}
1.1.13 - Show Baremetal
1.1.13.1 - 1.1
get /v1/baremetals/{baremetal_id}
Description
Show Bare Metal Server.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | baremetal_id required | Bare Metal Server ID Example : 20c507a036c447cdb3b19468d8ea62ac | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | BaremetalShowResponseV1Dot1 |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/baremetals/{baremetal_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal 1.1"
Example HTTP response
Response 200
{
"account_id": "f5c8e56a4d9b49a8bd89e14758a32d53",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "ef716e80-1fac-4faa-892d-0132fc7f5583",
"hyper_threading_use": true,
"id": "20c507a036c447cdb3b19468d8ea62ac",
"image_id": "IMAGE-7XFMaJpLsapKvskFMjCtmm",
"image_version": "RHEL 8.7 for BM",
"init_script": "init script",
"local_subnet_info": [
{
"interface_name": "ens8f1,bond_serv.2",
"local_subnet_id": "ab313c43291e4b678f4bacffe10768ae",
"policy_local_subnet_ip": "192.168.0.1",
"state": "CREATING",
"vlan_id": 500,
"vni_role_name": "mgmtJ4dzQBo"
}
],
"lock_enabled": true,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "ef716e80-1fac-4faa-892d-0132fc7f5583",
"network_id": "ab313c43291e4b678f4bacffe10768ae",
"os_type": "WINDOWS",
"placement_group_name": "pgtest",
"policy_ip": "192.168.0.1",
"private_nat_info": {
"nat_id": "a4fd0216cd32442a82733bbb8be0e82b",
"nat_ip": "192.170.2.10",
"nat_ip_id": "20c507a036c447cdb3b19468d8ea62ac",
"state": "ACTIVE",
"static_nat_id": "a1b97ae4695b40b0866e86a19cb191d3"
},
"product_type_id": "PRODUCT-0iT9dNiLr4lVoYmjlY2Vgg",
"public_nat_info": {
"nat_id": "a4fd0216cd32442a82733bbb8be0e82b",
"nat_ip": "192.170.2.10",
"nat_ip_id": "20c507a036c447cdb3b19468d8ea62ac",
"state": "ACTIVE",
"static_nat_id": "a1b97ae4695b40b0866e86a19cb191d3"
},
"region_id": "kr-west1",
"root_account": "rootaccount",
"server_name": "bmserver-001",
"server_type": "s1v8m32_metal",
"state": "RUNNING",
"time_zone": "Asia/Seoul",
"use_local_subnet": true,
"vpc_id": "e58348b1bc9148e5af86500fd4ef99ca"
}
1.1.13.2 - 1.0
get /v1/baremetals/{baremetal_id}
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | baremetal_id required | Bare Metal Server ID Example : 20c507a036c447cdb3b19468d8ea62ac | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | BaremetalShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/baremetals/{baremetal_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal 1.0"
Example HTTP response
Response 200
{
"account_id": "f5c8e56a4d9b49a8bd89e14758a32d53",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "ef716e80-1fac-4faa-892d-0132fc7f5583",
"hyper_threading_use": true,
"id": "20c507a036c447cdb3b19468d8ea62ac",
"image_id": "IMAGE-7XFMaJpLsapKvskFMjCtmm",
"image_version": "RHEL 8.7 for BM",
"init_script": "init script",
"local_subnet_info": [
{
"interface_name": "ens8f1,bond_serv.2",
"local_subnet_id": "ab313c43291e4b678f4bacffe10768ae",
"policy_local_subnet_ip": "192.168.0.1",
"state": "CREATING",
"vlan_id": 500,
"vni_role_name": "mgmtJ4dzQBo"
}
],
"lock_enabled": true,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "ef716e80-1fac-4faa-892d-0132fc7f5583",
"network_id": "ab313c43291e4b678f4bacffe10768ae",
"os_type": "WINDOWS",
"placement_group_name": "pgtest",
"policy_ip": "192.168.0.1",
"policy_nat": "192.168.0.1",
"policy_use_nat": true,
"product_type_id": "PRODUCT-0iT9dNiLr4lVoYmjlY2Vgg",
"public_nat_status": "ACTIVE",
"region_id": "kr-west1",
"root_account": "rootaccount",
"server_name": "bmserver-001",
"server_type": "s1v8m32_metal",
"state": "RUNNING",
"time_zone": "Asia/Seoul",
"use_local_subnet": true,
"vpc_id": "e58348b1bc9148e5af86500fd4ef99ca"
}
1.1.14 - Start Baremetals
1.1.14.1 - 1.1
post /v1/baremetals/start
Description
Start Bare Metal Servers.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | BaremetalsOperationRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | AsyncResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/baremetals/start
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal 1.1"
Request body
{
"bare_metal_server_ids": [
"20c507a036c447cdb3b19468d8ea62ac"
]
}
Example HTTP response
Response 202
{
"account_id": "f5c8e56a4d9b49a8bd89e14758a32d53",
"request_id": "req-002daa83-52d9-41e8-9b0f-d31d35610f65",
"resource_id": "20c507a036c447cdb3b19468d8ea62ac"
}
1.1.14.2 - 1.0
post /v1/baremetals/start
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | BaremetalsOperationRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | AsyncResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/baremetals/start
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal 1.0"
Request body
{
"bare_metal_server_ids": [
"20c507a036c447cdb3b19468d8ea62ac"
]
}
Example HTTP response
Response 202
{
"account_id": "f5c8e56a4d9b49a8bd89e14758a32d53",
"request_id": "req-002daa83-52d9-41e8-9b0f-d31d35610f65",
"resource_id": "20c507a036c447cdb3b19468d8ea62ac"
}
1.1.15 - Stop Baremetals
1.1.15.1 - 1.1
post /v1/baremetals/stop
Description
Stop Bare Metal Servers.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | BaremetalsOperationRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | AsyncResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/baremetals/stop
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal 1.1"
Request body
{
"bare_metal_server_ids": [
"20c507a036c447cdb3b19468d8ea62ac"
]
}
Example HTTP response
Response 202
{
"account_id": "f5c8e56a4d9b49a8bd89e14758a32d53",
"request_id": "req-002daa83-52d9-41e8-9b0f-d31d35610f65",
"resource_id": "20c507a036c447cdb3b19468d8ea62ac"
}
1.1.15.2 - 1.0
post /v1/baremetals/stop
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | BaremetalsOperationRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | AsyncResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/baremetals/stop
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal 1.0"
Request body
{
"bare_metal_server_ids": [
"20c507a036c447cdb3b19468d8ea62ac"
]
}
Example HTTP response
Response 202
{
"account_id": "f5c8e56a4d9b49a8bd89e14758a32d53",
"request_id": "req-002daa83-52d9-41e8-9b0f-d31d35610f65",
"resource_id": "20c507a036c447cdb3b19468d8ea62ac"
}
1.1.16 - Unlock Baremetal
1.1.16.1 - 1.1
put /v1/baremetals/{baremetal_id}/unlock
Description
Unlock Bare Metal Server.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | baremetal_id required | Bare Metal Server ID Example : 20c507a036c447cdb3b19468d8ea62ac | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | BaremetalActionResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/baremetals/{baremetal_id}/unlock
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal 1.1"
Example HTTP response
Response 200
{
"baremetal_id": "20c507a036c447cdb3b19468d8ea62ac"
}
1.1.16.2 - 1.0
put /v1/baremetals/{baremetal_id}/unlock
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | baremetal_id required | Bare Metal Server ID Example : 20c507a036c447cdb3b19468d8ea62ac | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | BaremetalActionResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/baremetals/{baremetal_id}/unlock
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal 1.0"
Example HTTP response
Response 200
{
"baremetal_id": "20c507a036c447cdb3b19468d8ea62ac"
}
1.2 - Models
1.2.1 - AsyncResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : f5c8e56a4d9b49a8bd89e14758a32d53 | string | |
| request_id required | Request ID Example : req-002daa83-52d9-41e8-9b0f-d31d35610f65 | string | |
| resource_id required | Resource ID Example : 20c507a036c447cdb3b19468d8ea62ac | string |
1.2.2 - BaremetalActionResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| baremetal_id required | Bare Metal Server ID Example : 20c507a036c447cdb3b19468d8ea62ac | string |
1.2.3 - BaremetalCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| image_id required | Image ID Example : IMAGE-7XFMaJpLsapKvskFMjCtmm | string | |
| init_script optional | Init script Example : init script | any of [string, null] | |
| lock_enabled optional | Use Lock Example : True | boolean | |
| os_user_id required | OS user ID Example : user001 | string | |
| os_user_password required | OS user password Example : password | string | |
| placement_group_name optional | Placement Group Name Example : pgtest | any of [string, null] | |
| region_id required | Region ID Example : kr-west1 | string | |
| server_details required | Detailed settings for each server | array[ServerDetailsRequest] | |
| subnet_id required | Subnet ID Example : ab313c43291e4b678f4bacffe10768ae | string | |
| tags optional | Tag | any of [array[TagRequest], null] | |
| use_placement_group optional | Use Placement Group Example : False | boolean | |
| vpc_id required | VPC ID Example : e58348b1bc9148e5af86500fd4ef99ca | string |
1.2.4 - BaremetalListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| baremetals required | array[BaremetalShowResponse] | ||
| count required | count Example : 20 | any of [integer, null] |
1.2.5 - BaremetalListResponseV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| baremetals required | array[BaremetalListV1Dot1] | ||
| count required | count Example : 20 | integer |
1.2.6 - BaremetalListV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| image_id required | Image ID Example : IMAGE-7XFMaJpLsapKvskFMjCtmm | string | |
| image_version required | Image version Example : RHEL 8.7 for BM | string | |
| lock_enabled optional | Use Lock Example : True | boolean | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| network_id required | Subnet ID Example : ab313c43291e4b678f4bacffe10768ae | string | |
| os_type required | OS type Example : WINDOWS | string | |
| placement_group_name optional | Placement Group Name Example : pgtest | any of [string, null] | |
| policy_ip required | Policy IP Example : 192.168.0.1 | string | |
| product_type_id required | Bare Metal Server scale ID Example : PRODUCT-0iT9dNiLr4lVoYmjlY2Vgg | string | |
| region_id required | Region ID Example : kr-west1 | string | |
| server_name required | Bare Metal Server name Example : bmserver-001 | string | |
| server_type required | Bare Metal Server scale type Example : s1v8m32_metal | string | |
| state required | Bare Metal Server state Example : RUNNING | string | |
| vpc_id required | VPC ID Example : e58348b1bc9148e5af86500fd4ef99ca | string |
1.2.7 - BaremetalServerAssignPrivateNatIpRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| private_nat_id required | Private NAT ID Example : a4fd0216cd32442a82733bbb8be0e82b | string | |
| private_nat_ip_id required | Private NAT IP ID Example : 03cd065d8acc4e47b11a11dc1411323e | string |
1.2.8 - BaremetalServerAssignPublicNatIpRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| public_ip_address_id required | Public IP ID Example : 20c507a036c447cdb3b19468d8ea62ac | string |
1.2.9 - BaremetalServerIdResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| baremetal_id required | Bare Metal Server ID Example : 20c507a036c447cdb3b19468d8ea62ac | string |
1.2.10 - BaremetalShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : f5c8e56a4d9b49a8bd89e14758a32d53 | string | |
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created by Example : ef716e80-1fac-4faa-892d-0132fc7f5583 | string | |
| hyper_threading_use required | Use Hyper Threading Example : True | boolean | |
| id required | Bare Metal Server ID Example : 20c507a036c447cdb3b19468d8ea62ac | string | |
| image_id required | Image ID Example : IMAGE-7XFMaJpLsapKvskFMjCtmm | string | |
| image_version required | Image version Example : RHEL 8.7 for BM | string | |
| init_script required | Init script Example : init script | string | |
| local_subnet_info optional | Local Subnet info | any of [array[LocalSubnetInfoResponse], null] | |
| lock_enabled optional | Use Lock Example : True | boolean | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified by Example : ef716e80-1fac-4faa-892d-0132fc7f5583 | string | |
| network_id required | Subnet ID Example : ab313c43291e4b678f4bacffe10768ae | string | |
| os_type required | OS type Example : WINDOWS | string | |
| placement_group_name optional | Placement Group Name Example : pgtest | any of [string, null] | |
| policy_ip required | Policy IP Example : 192.168.0.1 | string | |
| policy_nat optional | Public NAT IP Example : 192.168.0.1 | any of [string, null] | |
| policy_use_nat optional | Use Public NAT Example : True | boolean | |
| product_type_id required | Bare Metal Server scale ID Example : PRODUCT-0iT9dNiLr4lVoYmjlY2Vgg | string | |
| public_nat_status optional | Public NAT status Example : ACTIVE | any of [string, null] | |
| region_id required | Region ID Example : kr-west1 | string | |
| root_account required | Root Account Example : rootaccount | string | |
| server_name required | Bare Metal Server name Example : bmserver-001 | string | |
| server_type required | Bare Metal Server scale type Example : s1v8m32_metal | string | |
| state required | Bare Metal Server state Example : RUNNING | string | |
| time_zone required | Time Zone Example : Asia/Seoul | string | |
| use_local_subnet optional | Use Local Subnet Example : True | boolean | |
| vpc_id required | VPC ID Example : e58348b1bc9148e5af86500fd4ef99ca | string |
1.2.11 - BaremetalShowResponseV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : f5c8e56a4d9b49a8bd89e14758a32d53 | string | |
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created by Example : ef716e80-1fac-4faa-892d-0132fc7f5583 | string | |
| hyper_threading_use required | Use Hyper Threading Example : True | boolean | |
| id required | Bare Metal Server ID Example : 20c507a036c447cdb3b19468d8ea62ac | string | |
| image_id required | Image ID Example : IMAGE-7XFMaJpLsapKvskFMjCtmm | string | |
| image_version required | Image version Example : RHEL 8.7 for BM | string | |
| init_script required | Init script Example : init script | string | |
| local_subnet_info optional | Local Subnet info | any of [array[LocalSubnetInfoResponse], null] | |
| lock_enabled optional | Use Lock Example : True | boolean | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified by Example : ef716e80-1fac-4faa-892d-0132fc7f5583 | string | |
| network_id required | Subnet ID Example : ab313c43291e4b678f4bacffe10768ae | string | |
| os_type required | OS type Example : WINDOWS | string | |
| placement_group_name optional | Placement Group Name Example : pgtest | any of [string, null] | |
| policy_ip required | Policy IP Example : 192.168.0.1 | string | |
| private_nat_info optional | Private NAT info | any of [BaremetalStaticNatResponseV1Dot1, null] | |
| product_type_id required | Bare Metal Server scale ID Example : PRODUCT-0iT9dNiLr4lVoYmjlY2Vgg | string | |
| public_nat_info optional | Public NAT info | any of [BaremetalStaticNatResponseV1Dot1, null] | |
| region_id required | Region ID Example : kr-west1 | string | |
| root_account required | Root Account Example : rootaccount | string | |
| server_name required | Bare Metal Server name Example : bmserver-001 | string | |
| server_type required | Bare Metal Server scale type Example : s1v8m32_metal | string | |
| state required | Bare Metal Server state Example : RUNNING | string | |
| time_zone required | Time Zone Example : Asia/Seoul | string | |
| use_local_subnet optional | Use Local Subnet Example : True | boolean | |
| vpc_id required | VPC ID Example : e58348b1bc9148e5af86500fd4ef99ca | string |
1.2.12 - BaremetalsOperationRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| bare_metal_server_ids required | Bare Metal Server IDs Example : ['20c507a036c447cdb3b19468d8ea62ac'] | array[object] |
1.2.13 - BaremetalStaticNatResponseV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| nat_id optional | NAT ID Example : a4fd0216cd32442a82733bbb8be0e82b | any of [string, null] | |
| nat_ip required | NAT IP Example : 192.170.2.10 | string | |
| nat_ip_id required | NAT IP ID Example : 20c507a036c447cdb3b19468d8ea62ac | string | |
| state required | Static NAT state Example : ACTIVE | string | |
| static_nat_id optional | Static NAT ID Example : a1b97ae4695b40b0866e86a19cb191d3 | any of [string, null] |
1.2.14 - BaremetalTerminateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| baremetal_id_list required | Bare Metal Server IDs Example : ['20c507a036c447cdb3b19468d8ea62ac'] | array[object] |
1.2.15 - ImageListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| images required | array[ImageShowResponse] |
1.2.16 - ImageShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | Created at Example : 2024-07-11 08:56:59 | string | |
| id required | Image ID Example : IMAGE-7XFMaJpLsapKvskFMjCtmm | string | |
| name required | Image name Example : RHEL 8.8 for BM | string | |
| os_distro required | OS type Example : RHEL | string | |
| scp_image_type required | Image Type Example : STANDARD | string | |
| scp_os_version required | OS version Example : 8.7 | string |
1.2.17 - LocalDiskPartitionsRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| mount_point required | Mount Point Example : /mountpoint | string | |
| partition_name optional | Partition Name Example : partitionname | any of [string, null] | |
| partition_size required | Partition Size Example : 20 | integer | |
| partition_type required | Partition Type Example : ext4 | string |
1.2.18 - LocalSubnetAttachRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| local_subnet_id required | Local Subnet ID Example : ab313c43291e4b678f4bacffe10768ae | string | |
| local_subnet_ip optional | Policy Local Subnet IP Example : 192.168.0.1 | any of [string, null] |
1.2.19 - LocalSubnetDetachRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| local_subnet_id required | Local Subnet ID Example : ab313c43291e4b678f4bacffe10768ae | string | |
| local_subnet_ip required | Policy Local Subnet IP Example : 192.168.0.1 | string |
1.2.20 - LocalSubnetInfoResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| interface_name required | Interface Name Example : ens8f1,bond_serv.2 | string | |
| local_subnet_id required | Local Subnet ID Example : ab313c43291e4b678f4bacffe10768ae | string | |
| policy_local_subnet_ip required | Policy Local Subnet IP Example : 192.168.0.1 | string | |
| state required | LocalSubnet IP state Example : CREATING | string | |
| vlan_id required | Vlan Id Example : 500 | string | |
| vni_role_name required | VNI Role Name Example : mgmtJ4dzQBo | string |
1.2.21 - LocalSubnetResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| baremetal_id required | Bare Metal Server ID Example : 20c507a036c447cdb3b19468d8ea62ac | string | |
| is_success optional | success flag Example : True | boolean |
1.2.22 - ProductListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| products required | Product List | array[ProductShowResponse] |
1.2.23 - ProductListResponseV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| products required | Product List | array[ProductShowResponseV1Dot1] |
1.2.24 - ProductShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| attri_name required | Attribute name Example : attri name | string | |
| attri_value required | Attribute value Example : attri value | string | |
| compute_class_type_name required | Compute class type name Example : StandardMetal-2 | string | |
| compute_class_type_unit required | Compute class type unit Example : compute_class_type_unit | string | |
| compute_class_type_value required | Compute class type value Example : s2_metal | string | |
| cpu_generation required | CPU generation Example : cpu generation | string | |
| cpu_name required | CPU name Example : cpu 16 vCore | string | |
| cpu_unit required | CPU unit Example : vCPU | string | |
| cpu_value required | CPU value Example : 64 | string | |
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| description required | Description Example : vCPU 16 │ Memory 128G │ Disk 480G | string | |
| disk_name required | Disk name Example : disk_name | string | |
| disk_unit required | Disk unit Example : GB | string | |
| disk_value required | Disk value Example : 480 | string | |
| id required | ID Example : PRODUCT-0iT9dNiLr4lVoYmjlY2Vgg | string | |
| infiniband_name required | InfiniBand name Example : infiniband_name | string | |
| infiniband_unit required | InfiniBand unit Example : infiniband_unit | string | |
| infiniband_value required | Infiniband value Example : infiniband_value | string | |
| memory_name required | Memory name Example : server memory 128GB | string | |
| memory_unit required | Memory unit Example : GB | string | |
| memory_value required | Memory value Example : 128 | string | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name required | Name Example : s2v16m128_metal | string | |
| name_with_generation required | Name with generation Example : s2v16m128_metal | string | |
| socket_name required | Socket name Example : socket_name | string | |
| socket_unit required | Socket unit Example : socket_unit | string | |
| socket_value required | Socket value Example : socket_value | string | |
| state required | State Example : AVAILABLE | string | |
| type required | Type Example : SCALE | string |
1.2.25 - ProductShowResponseV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| compute_class_type_name required | Compute class type name Example : StandardMetal-2 | string | |
| compute_class_type_value required | Compute class type value Example : s2_metal | string | |
| cpu_name required | CPU name Example : cpu 16 vCore | any of [string, null] | |
| cpu_unit required | CPU unit Example : vCPU | string | |
| cpu_value required | CPU value Example : 64 | string | |
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| description required | Description Example : vCPU 16 │ Memory 128G │ Disk 480G | any of [string, null] | |
| disk_unit required | Disk unit Example : GB | any of [string, null] | |
| disk_value required | Disk value Example : 480 | string | |
| id required | ID Example : PRODUCT-0iT9dNiLr4lVoYmjlY2Vgg | string | |
| memory_name required | Memory name Example : server memory 128GB | any of [string, null] | |
| memory_unit required | Memory unit Example : GB | any of [string, null] | |
| memory_value required | Memory value Example : 128 | string | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| name required | Name Example : s2v16m128_metal | string | |
| name_with_generation required | Name with generation Example : s2v16m128_metal | string | |
| os_disk_gb required | OS disk value Example : 480 | string | |
| state required | State Example : AVAILABLE | string | |
| type required | Type Example : SCALE | string |
1.2.26 - ServerDetailsRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| bare_metal_local_subnet_id optional | Local Subnet ID Example : ab313c43291e4b678f4bacffe10768ae | any of [string, null] | |
| bare_metal_local_subnet_ip_address optional | Policy Local Subnet IP Example : 192.168.0.1 | any of [string, null] | |
| bare_metal_server_name required | Bare Metal Server name Example : bmserver-001 | string | |
| ip_address optional | Private IP Example : 192.168.0.1 | any of [string, null] | |
| local_disk_partitions optional | Local Disk Partitions | any of [array[LocalDiskPartitionsRequest], null] | |
| local_disk_type optional | Local Disk Type Example : flat | any of [string, null] | |
| nat_enabled required | Use Public NAT Example : True | boolean | |
| public_ip_address_id optional | Public IP ID Example : 20c507a036c447cdb3b19468d8ea62ac | any of [string, null] | |
| server_type_id required | Server Type ID Example : PRODUCT-0iT9dNiLr4lVoYmjlY2Vgg | string | |
| use_hyper_threading optional | Use Hyper Threading Example : True | boolean |
1.2.27 - TagRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| key required | key Example : key | string | |
| value optional | value Example : value | any of [string, null] |
2 - Cloud Functions
Overview
Provides an Application Programming Interface (API) that supports programmatic use of IaaS/PaaS products provided by SCP.
This guide provides a brief description of Cloud Function service and how to call API. The API is provided as a RESTful API, and it responds in JSON format.
Version
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Status | Not Before |
|---|---|---|
| 1.3 | CURRENT | - |
| 1.2 | DEPRECATED | 20260630 |
| 1.1 | DEPRECATED | 20260430 |
| 1.0 | DEPRECATED | 20251231 |
OpenAPI URL
https://scf.{region}.{environment}.samsungsdscloud.com
Environment and Region List
| environment | region |
|---|---|
| s | kr-west1 |
| s | kr-east1 |
| g | kr-south1 |
| g | kr-south2 |
| g | kr-south3 |
| e | kr-west1 |
| e | kr-east1 |
2.1 - APIs
2.1.1 - Approve PrivateLink Endpoint
2.1.1.1 - 1.3
put /v1/cloud-functions/{cloud_function_id}/configurations/privatelink-endpoints/{endpoint_id}/approval
Description
approve PrivateLink Endpoint
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| path | endpoint_id required | Endpoint Id Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| body | body required | PrivateLinkEndpointApproval |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PrivateLinkEndpoint |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/configurations/privatelink-endpoints/{endpoint_id}/approval
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.3"
Request body
{
"type": "APPROVE"
}
Example HTTP response
Response 200
{
"endpoint": {
"endpoint_alias": "sample",
"endpoint_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"service_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"state": "Active"
}
}
2.1.1.2 - 1.2
put /v1/cloud-functions/{cloud_function_id}/configurations/privatelink-endpoints/{endpoint_id}/approval
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| path | endpoint_id required | Endpoint Id Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| body | body required | PrivateLinkEndpointApproval |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PrivateLinkEndpoint |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/configurations/privatelink-endpoints/{endpoint_id}/approval
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.2"
Request body
{
"type": "APPROVE"
}
Example HTTP response
Response 200
{
"endpoint": {
"endpoint_alias": "sample",
"endpoint_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"service_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"state": "Active"
}
}
2.1.2 - Check Function Name Duplication
2.1.2.1 - 1.3
get /v1/cloud-functions/check-duplication
Description
check name duplication
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | name required | Name Example : sample-function-name | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | DuplicationShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/check-duplication?name={name}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.3"
Example HTTP response
Response 200
{
"result": true
}
2.1.2.2 - 1.2
get /v1/cloud-functions/check-duplication
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | name required | Name Example : sample-function-name | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | DuplicationShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/check-duplication?name={name}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.2"
Example HTTP response
Response 200
{
"result": true
}
2.1.2.3 - 1.1
get /v1/cloud-functions/check-duplication
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | name required | Name Example : sample-function-name | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | DuplicationShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/check-duplication?name={name}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.1"
Example HTTP response
Response 200
{
"result": true
}
2.1.2.4 - 1.0
get /v1/cloud-functions/check-duplication
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | name required | Name Example : sample-function-name | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | DuplicationShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/check-duplication?name={name}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.0"
Example HTTP response
Response 200
{
"result": true
}
2.1.3 - Connect PrivateLink Endpoint
2.1.3.1 - 1.3
put /v1/cloud-functions/{cloud_function_id}/configurations/privatelink-endpoints/{endpoint_id}/connection
Description
connect PrivateLink Endpoint
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| path | endpoint_id required | Endpoint Id Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| body | body required | PrivateLinkEndpointConnection |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PrivateLinkEndpoint |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/configurations/privatelink-endpoints/{endpoint_id}/connection
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.3"
Request body
{
"type": "RECONNECT"
}
Example HTTP response
Response 200
{
"endpoint": {
"endpoint_alias": "sample",
"endpoint_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"service_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"state": "Active"
}
}
2.1.3.2 - 1.2
put /v1/cloud-functions/{cloud_function_id}/configurations/privatelink-endpoints/{endpoint_id}/connection
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| path | endpoint_id required | Endpoint Id Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| body | body required | PrivateLinkEndpointConnection |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PrivateLinkEndpoint |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/configurations/privatelink-endpoints/{endpoint_id}/connection
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.2"
Request body
{
"type": "RECONNECT"
}
Example HTTP response
Response 200
{
"endpoint": {
"endpoint_alias": "sample",
"endpoint_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"service_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"state": "Active"
}
}
2.1.4 - Create Cloud Function
2.1.4.1 - 1.3
post /v1/cloud-functions
Description
create a cloud_function
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | CloudFunctionCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | CloudFunctionCreateResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.3"
Request body
{
"content": "sample",
"name": "sample-function-name",
"runtime": "Node.js:20",
"tags": [
{
"key": "",
"value": ""
}
]
}
Example HTTP response
Response 202
{
"id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"message": "Description",
"state": "READY"
}
2.1.4.2 - 1.2
post /v1/cloud-functions
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | CloudFunctionCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | CloudFunctionCreateResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.2"
Request body
{
"content": "sample",
"name": "sample-function-name",
"runtime": "Node.js:20",
"tags": [
{
"key": "",
"value": ""
}
]
}
Example HTTP response
Response 202
{
"id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"message": "Description",
"state": "READY"
}
2.1.4.3 - 1.1
post /v1/cloud-functions
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | CloudFunctionCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | CloudFunctionCreateResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.1"
Request body
{
"content": "sample",
"name": "sample-function-name",
"runtime": "Node.js:20",
"tags": [
{
"key": "",
"value": ""
}
]
}
Example HTTP response
Response 202
{
"id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"message": "Description",
"state": "READY"
}
2.1.4.4 - 1.0
post /v1/cloud-functions
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | CloudFunctionCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | CloudFunctionCreateResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.0"
Request body
{
"content": "sample",
"name": "sample-function-name",
"runtime": "Node.js:20",
"tags": [
{
"key": "",
"value": ""
}
]
}
Example HTTP response
Response 202
{
"id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"message": "Description",
"state": "READY"
}
2.1.5 - Create Cloud Function Apigateway Trigger
2.1.5.1 - 1.3
post /v1/triggers/apigateway
Description
create cloud-function apigateway trigger
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | ApigatewayTriggerCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | TriggerCreateResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/triggers/apigateway
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.3"
Request body
{
"apigateway_api_id": "31e749b7b260868f441e862b",
"apigateway_stage_name": "sample",
"cloud_function_id": "8c9f6c1c928a45b4bbd1e4da5531d656"
}
Example HTTP response
Response 200
{
"alias": "$LATEST",
"cloud_function_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"triggers": [
{
"schedule": "* * * * 0",
"timezone": "Asia/Tokyo",
"trigger_id": 1,
"trigger_name": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_target_account_id": "617b3d0e90c24a5fa1f65a3824861354",
"trigger_target_srn": "srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe",
"trigger_target_uuid": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_type": "apigateway"
}
]
}
2.1.5.2 - 1.2
post /v1/triggers/apigateway
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | ApigatewayTriggerCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | TriggerCreateResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/triggers/apigateway
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.2"
Request body
{
"apigateway_api_id": "31e749b7b260868f441e862b",
"apigateway_stage_name": "sample",
"cloud_function_id": "8c9f6c1c928a45b4bbd1e4da5531d656"
}
Example HTTP response
Response 200
{
"alias": "$LATEST",
"cloud_function_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"triggers": [
{
"schedule": "* * * * 0",
"timezone": "Asia/Tokyo",
"trigger_id": 1,
"trigger_name": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_target_account_id": "617b3d0e90c24a5fa1f65a3824861354",
"trigger_target_srn": "srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe",
"trigger_target_uuid": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_type": "apigateway"
}
]
}
2.1.5.3 - 1.1
post /v1/triggers/apigateway
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | ApigatewayTriggerCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | TriggerCreateResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/triggers/apigateway
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.1"
Request body
{
"apigateway_api_id": "31e749b7b260868f441e862b",
"apigateway_stage_name": "sample",
"cloud_function_id": "8c9f6c1c928a45b4bbd1e4da5531d656"
}
Example HTTP response
Response 200
{
"alias": "$LATEST",
"cloud_function_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"triggers": [
{
"schedule": "* * * * 0",
"timezone": "Asia/Tokyo",
"trigger_id": 1,
"trigger_name": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_target_account_id": "617b3d0e90c24a5fa1f65a3824861354",
"trigger_target_srn": "srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe",
"trigger_target_uuid": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_type": "apigateway"
}
]
}
2.1.5.4 - 1.0
post /v1/triggers/apigateway
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | ApigatewayTriggerCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | TriggerCreateResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/triggers/apigateway
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.0"
Request body
{
"apigateway_api_id": "31e749b7b260868f441e862b",
"apigateway_stage_name": "sample",
"cloud_function_id": "8c9f6c1c928a45b4bbd1e4da5531d656"
}
Example HTTP response
Response 200
{
"alias": "$LATEST",
"cloud_function_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"triggers": [
{
"schedule": "* * * * 0",
"timezone": "Asia/Tokyo",
"trigger_id": 1,
"trigger_name": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_target_account_id": "617b3d0e90c24a5fa1f65a3824861354",
"trigger_target_srn": "srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe",
"trigger_target_uuid": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_type": "apigateway"
}
]
}
2.1.6 - Create Cloud Function Cronjob Trigger
2.1.6.1 - 1.3
post /v1/triggers/cronjob
Description
create cloud-function cronjob trigger
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | CronjobTriggerCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | TriggerCreateResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/triggers/cronjob
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.3"
Request body
{
"cloud_function_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"schedule": "* * * * 0",
"timezone": "Asia/Tokyo"
}
Example HTTP response
Response 200
{
"alias": "$LATEST",
"cloud_function_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"triggers": [
{
"schedule": "* * * * 0",
"timezone": "Asia/Tokyo",
"trigger_id": 1,
"trigger_name": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_target_account_id": "617b3d0e90c24a5fa1f65a3824861354",
"trigger_target_srn": "srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe",
"trigger_target_uuid": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_type": "apigateway"
}
]
}
2.1.6.2 - 1.2
post /v1/triggers/cronjob
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | CronjobTriggerCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | TriggerCreateResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/triggers/cronjob
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.2"
Request body
{
"cloud_function_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"schedule": "* * * * 0",
"timezone": "Asia/Tokyo"
}
Example HTTP response
Response 200
{
"alias": "$LATEST",
"cloud_function_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"triggers": [
{
"schedule": "* * * * 0",
"timezone": "Asia/Tokyo",
"trigger_id": 1,
"trigger_name": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_target_account_id": "617b3d0e90c24a5fa1f65a3824861354",
"trigger_target_srn": "srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe",
"trigger_target_uuid": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_type": "apigateway"
}
]
}
2.1.6.3 - 1.1
post /v1/triggers/cronjob
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | CronjobTriggerCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | TriggerCreateResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/triggers/cronjob
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.1"
Request body
{
"cloud_function_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"schedule": "* * * * 0",
"timezone": "Asia/Tokyo"
}
Example HTTP response
Response 200
{
"alias": "$LATEST",
"cloud_function_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"triggers": [
{
"schedule": "* * * * 0",
"timezone": "Asia/Tokyo",
"trigger_id": 1,
"trigger_name": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_target_account_id": "617b3d0e90c24a5fa1f65a3824861354",
"trigger_target_srn": "srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe",
"trigger_target_uuid": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_type": "apigateway"
}
]
}
2.1.6.4 - 1.0
post /v1/triggers/cronjob
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | CronjobTriggerCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | TriggerCreateResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/triggers/cronjob
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.0"
Request body
{
"cloud_function_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"schedule": "* * * * 0",
"timezone": "Asia/Tokyo"
}
Example HTTP response
Response 200
{
"alias": "$LATEST",
"cloud_function_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"triggers": [
{
"schedule": "* * * * 0",
"timezone": "Asia/Tokyo",
"trigger_id": 1,
"trigger_name": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_target_account_id": "617b3d0e90c24a5fa1f65a3824861354",
"trigger_target_srn": "srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe",
"trigger_target_uuid": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_type": "apigateway"
}
]
}
2.1.7 - Create PrivateLink Endpoint
2.1.7.1 - 1.3
post /v1/cloud-functions/{cloud_function_id}/configurations/privatelink-endpoints
Description
create privateLink endpoint
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| body | body required | PrivateLinkEndpointCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PrivateLinkEndpoint |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/configurations/privatelink-endpoints
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.3"
Request body
{
"endpoint": {
"alias": "sample",
"service_id": "8c9f6c1c928a45b4bbd1e4da5531d656"
}
}
Example HTTP response
Response 200
{
"endpoint": {
"endpoint_alias": "sample",
"endpoint_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"service_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"state": "Active"
}
}
2.1.7.2 - 1.2
post /v1/cloud-functions/{cloud_function_id}/configurations/privatelink-endpoints
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| body | body required | PrivateLinkEndpointCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PrivateLinkEndpoint |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/configurations/privatelink-endpoints
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.2"
Request body
{
"endpoint": {
"alias": "sample",
"service_id": "8c9f6c1c928a45b4bbd1e4da5531d656"
}
}
Example HTTP response
Response 200
{
"endpoint": {
"endpoint_alias": "sample",
"endpoint_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"service_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"state": "Active"
}
}
2.1.8 - Delete Cloud Function
2.1.8.1 - 1.3
delete /v1/cloud-functions/{cloud_function_id}
Description
delete a specific cloud_function
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.3"
Example HTTP response
Response 204
2.1.8.2 - 1.2
delete /v1/cloud-functions/{cloud_function_id}
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.2"
Example HTTP response
Response 204
2.1.8.3 - 1.1
delete /v1/cloud-functions/{cloud_function_id}
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.1"
Example HTTP response
Response 204
2.1.8.4 - 1.0
delete /v1/cloud-functions/{cloud_function_id}
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.0"
Example HTTP response
Response 204
2.1.9 - Delete Cloud Function Trigger
2.1.9.1 - 1.3
delete /v1/triggers/{trigger_id}
Description
delete a specific cloud function trigger
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | trigger_id required | Trigger ID Example : 1 | integer | None |
| body | body required | TriggerDeleteRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/triggers/{trigger_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.3"
Request body
{
"cloud_function_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_type": "apigateway"
}
Example HTTP response
Response 204
2.1.9.2 - 1.2
delete /v1/triggers/{trigger_id}
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | trigger_id required | Trigger ID Example : 1 | integer | None |
| body | body required | TriggerDeleteRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/triggers/{trigger_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.2"
Request body
{
"cloud_function_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_type": "apigateway"
}
Example HTTP response
Response 204
2.1.9.3 - 1.1
delete /v1/triggers/{trigger_id}
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | trigger_id required | Trigger ID Example : 1 | integer | None |
| body | body required | TriggerDeleteRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/triggers/{trigger_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.1"
Request body
{
"cloud_function_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_type": "apigateway"
}
Example HTTP response
Response 204
2.1.9.4 - 1.0
delete /v1/triggers/{trigger_id}
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | trigger_id required | Trigger ID Example : 1 | integer | None |
| body | body required | TriggerDeleteRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/triggers/{trigger_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.0"
Request body
{
"cloud_function_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_type": "apigateway"
}
Example HTTP response
Response 204
2.1.10 - Delete PrivateLink Endpoint
2.1.10.1 - 1.3
delete /v1/cloud-functions/{cloud_function_id}/configurations/privatelink-endpoints/{endpoint_id}
Description
delete privateLink endpoint
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| path | endpoint_id required | Endpoint Id Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/configurations/privatelink-endpoints/{endpoint_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.3"
Example HTTP response
Response 204
2.1.10.2 - 1.2
delete /v1/cloud-functions/{cloud_function_id}/configurations/privatelink-endpoints/{endpoint_id}
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| path | endpoint_id required | Endpoint Id Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/configurations/privatelink-endpoints/{endpoint_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.2"
Example HTTP response
Response 204
2.1.11 - Delete Resource Policy
2.1.11.1 - 1.3
delete /v1/cloud-functions/{cloud_function_id}/configurations/resource-policies
Description
Delete resource policy
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/configurations/resource-policies
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.3"
Example HTTP response
Response 204
2.1.12 - List Cloud Function Triggers
2.1.12.1 - 1.3
get /v1/triggers
Description
list cloud-function triggers
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | sort optional | sort Example : name:asc | any of [string, null] | None |
| query | page optional | page Example : 0 | any of [integer, null] | None |
| query | size optional | size Example : 20 | any of [integer, null] | None |
| query | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| query | trigger_name optional | Trigger name Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | any of [string, null] | None |
| query | trigger_type optional | Trigger type Example : apigateway | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | TriggersResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/triggers?cloud_function_id={cloud_function_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.3"
Example HTTP response
Response 200
{
"alias": "$LATEST",
"count": 20,
"triggers": [
{
"schedule": "* * * * 0",
"timezone": "Asia/Tokyo",
"trigger_id": 1,
"trigger_name": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_target_account_id": "617b3d0e90c24a5fa1f65a3824861354",
"trigger_target_srn": "srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe",
"trigger_target_uuid": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_type": "apigateway"
}
]
}
2.1.12.2 - 1.2
get /v1/triggers
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | sort optional | sort Example : name:asc | any of [string, null] | None |
| query | page optional | page Example : 0 | any of [integer, null] | None |
| query | size optional | size Example : 20 | any of [integer, null] | None |
| query | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| query | trigger_name optional | Trigger name Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | any of [string, null] | None |
| query | trigger_type optional | Trigger type Example : apigateway | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | TriggersResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/triggers?cloud_function_id={cloud_function_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.2"
Example HTTP response
Response 200
{
"alias": "$LATEST",
"count": 20,
"triggers": [
{
"schedule": "* * * * 0",
"timezone": "Asia/Tokyo",
"trigger_id": 1,
"trigger_name": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_target_account_id": "617b3d0e90c24a5fa1f65a3824861354",
"trigger_target_srn": "srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe",
"trigger_target_uuid": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_type": "apigateway"
}
]
}
2.1.12.3 - 1.1
get /v1/triggers
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | sort optional | sort Example : name:asc | any of [string, null] | None |
| query | page optional | page Example : 0 | any of [integer, null] | None |
| query | size optional | size Example : 20 | any of [integer, null] | None |
| query | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| query | trigger_name optional | Trigger name Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | any of [string, null] | None |
| query | trigger_type optional | Trigger type Example : apigateway | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | TriggersResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/triggers?cloud_function_id={cloud_function_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.1"
Example HTTP response
Response 200
{
"alias": "$LATEST",
"count": 20,
"triggers": [
{
"schedule": "* * * * 0",
"timezone": "Asia/Tokyo",
"trigger_id": 1,
"trigger_name": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_target_account_id": "617b3d0e90c24a5fa1f65a3824861354",
"trigger_target_srn": "srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe",
"trigger_target_uuid": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_type": "apigateway"
}
]
}
2.1.12.4 - 1.0
get /v1/triggers
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | sort optional | sort Example : name:asc | any of [string, null] | None |
| query | page optional | page Example : 0 | any of [integer, null] | None |
| query | size optional | size Example : 20 | any of [integer, null] | None |
| query | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| query | trigger_name optional | Trigger name Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | any of [string, null] | None |
| query | trigger_type optional | Trigger type Example : apigateway | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | TriggersResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/triggers?cloud_function_id={cloud_function_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.0"
Example HTTP response
Response 200
{
"alias": "$LATEST",
"count": 20,
"triggers": [
{
"schedule": "* * * * 0",
"timezone": "Asia/Tokyo",
"trigger_id": 1,
"trigger_name": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_target_account_id": "617b3d0e90c24a5fa1f65a3824861354",
"trigger_target_srn": "srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe",
"trigger_target_uuid": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_type": "apigateway"
}
]
}
2.1.13 - List Cloud Functions
2.1.13.1 - 1.3
get /v1/cloud-functions
Description
get cloud_functions list
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | sort optional | sort Example : name:asc | any of [string, null] | None |
| query | page optional | page Example : 0 | any of [integer, null] | None |
| query | size optional | size Example : 20 | any of [integer, null] | None |
| query | name optional | Name Example : sample-function-name | any of [string, null] | None |
| query | state optional | Cloud function state Example : READY | any of [array[string], string, null] | None |
| query | runtime optional | Runtime Example : Node.js:20 | any of [array[string], string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | CloudFunctionListResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.3"
Example HTTP response
Response 200
{
"cloud_functions": [
{
"account_id": "617b3d0e90c24a5fa1f65a3824861354",
"created_at": "2025-05-22T06:21:17.580522",
"function_url": "https://33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/cloudfunctions-hello",
"id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"name": "sample",
"runtime": "Node.js:20",
"state": "READY",
"user_id": "617b3d0e90c24a5fa1f65a3824861354"
}
],
"count": 20
}
2.1.13.2 - 1.2
get /v1/cloud-functions
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | sort optional | sort Example : name:asc | any of [string, null] | None |
| query | page optional | page Example : 0 | any of [integer, null] | None |
| query | size optional | size Example : 20 | any of [integer, null] | None |
| query | name optional | Name Example : sample-function-name | any of [string, null] | None |
| query | state optional | Cloud function state Example : READY | any of [array[string], string, null] | None |
| query | runtime optional | Runtime Example : Node.js:20 | any of [array[string], string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | CloudFunctionListResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.2"
Example HTTP response
Response 200
{
"cloud_functions": [
{
"account_id": "617b3d0e90c24a5fa1f65a3824861354",
"created_at": "2025-05-22T06:21:17.580522",
"function_url": "https://33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/cloudfunctions-hello",
"id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"name": "sample",
"runtime": "Node.js:20",
"state": "READY",
"user_id": "617b3d0e90c24a5fa1f65a3824861354"
}
],
"count": 20
}
2.1.13.3 - 1.1
get /v1/cloud-functions
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | sort optional | sort Example : name:asc | any of [string, null] | None |
| query | page optional | page Example : 0 | any of [integer, null] | None |
| query | size optional | size Example : 20 | any of [integer, null] | None |
| query | name optional | Name Example : sample-function-name | any of [string, null] | None |
| query | state optional | Cloud function state Example : READY | any of [array[string], string, null] | None |
| query | runtime optional | Runtime Example : Node.js:20 | any of [array[string], string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | CloudFunctionListResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.1"
Example HTTP response
Response 200
{
"cloud_functions": [
{
"account_id": "617b3d0e90c24a5fa1f65a3824861354",
"created_at": "2025-05-22T06:21:17.580522",
"function_url": "https://33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/cloudfunctions-hello",
"id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"name": "sample",
"runtime": "Node.js:20",
"state": "READY",
"user_id": "617b3d0e90c24a5fa1f65a3824861354"
}
],
"count": 20
}
2.1.13.4 - 1.0
get /v1/cloud-functions
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | sort optional | sort Example : name:asc | any of [string, null] | None |
| query | page optional | page Example : 0 | any of [integer, null] | None |
| query | size optional | size Example : 20 | any of [integer, null] | None |
| query | name optional | Name Example : sample-function-name | any of [string, null] | None |
| query | state optional | Cloud function state Example : READY | any of [array[string], string, null] | None |
| query | runtime optional | Runtime Example : Node.js:20 | any of [array[string], string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | CloudFunctionListResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.0"
Example HTTP response
Response 200
{
"cloud_functions": [
{
"account_id": "617b3d0e90c24a5fa1f65a3824861354",
"created_at": "2025-05-22T06:21:17.580522",
"function_url": "https://33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/cloudfunctions-hello",
"id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"name": "sample",
"runtime": "Node.js:20",
"state": "READY",
"user_id": "617b3d0e90c24a5fa1f65a3824861354"
}
],
"count": 20
}
2.1.14 - List Environment Variables
2.1.14.1 - 1.3
get /v1/cloud-functions/{cloud_function_id}/configurations/environment-variables
Description
list environment variables
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| query | sort optional | Sort Example : key:asc | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | FunctionVariables |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/configurations/environment-variables
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.3"
Example HTTP response
Response 200
{
"variables": [
{
"key": "sample",
"value": "sample"
}
]
}
2.1.15 - List PrivateLink Endpoint
2.1.15.1 - 1.3
get /v1/cloud-functions/{cloud_function_id}/configurations/privatelink-endpoints
Description
list privateLink endpoint
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| query | sort optional | Sort Example : endpoint_alias:asc | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PrivateLinkEndpointList |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/configurations/privatelink-endpoints
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.3"
Example HTTP response
Response 200
{
"privatelink_endpoints": [
{
"endpoint_alias": "sample",
"endpoint_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"service_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"state": "Active"
}
]
}
2.1.16 - List Runtimes
2.1.16.1 - 1.3
get /v1/cloud-functions/runtimes
Description
list runtimes
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | RuntimeListResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/runtimes
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.3"
Example HTTP response
Response 200
{
"count": "3",
"runtimes": [
{
"base_image_seq": "3",
"name": "sample",
"version": "1.0.0"
}
]
}
2.1.16.2 - 1.2
get /v1/cloud-functions/runtimes
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
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | RuntimeListResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/runtimes
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.2"
Example HTTP response
Response 200
{
"count": "3",
"runtimes": [
{
"base_image_seq": "3",
"name": "sample",
"version": "1.0.0"
}
]
}
2.1.16.3 - 1.1
get /v1/cloud-functions/runtimes
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
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | RuntimeListResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/runtimes
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.1"
Example HTTP response
Response 200
{
"count": "3",
"runtimes": [
{
"base_image_seq": "3",
"name": "sample",
"version": "1.0.0"
}
]
}
2.1.16.4 - 1.0
get /v1/cloud-functions/runtimes
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
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | RuntimeListResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/runtimes
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.0"
Example HTTP response
Response 200
{
"count": "3",
"runtimes": [
{
"base_image_seq": "3",
"name": "sample",
"version": "1.0.0"
}
]
}
2.1.17 - List Sample Codes
2.1.17.1 - 1.3
get /v1/cloud-functions/sample-codes
Description
List sample codes
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SampleCodesListResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/sample-codes
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.3"
Example HTTP response
Response 200
{
"count": "3",
"sample_codes": [
{
"content": "sample",
"default": false,
"description": "sample",
"name": "sample",
"runtime": "Node.js:20",
"seq": "3",
"version": "sample"
}
]
}
2.1.17.2 - 1.2
get /v1/cloud-functions/sample-codes
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
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SampleCodesListResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/sample-codes
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.2"
Example HTTP response
Response 200
{
"count": "3",
"sample_codes": [
{
"content": "sample",
"default": false,
"description": "sample",
"name": "sample",
"runtime": "Node.js:20",
"seq": "3",
"version": "sample"
}
]
}
2.1.17.3 - 1.1
get /v1/cloud-functions/sample-codes
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
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SampleCodesListResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/sample-codes
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.1"
Example HTTP response
Response 200
{
"count": "3",
"sample_codes": [
{
"content": "sample",
"default": false,
"description": "sample",
"name": "sample",
"runtime": "Node.js:20",
"seq": "3",
"version": "sample"
}
]
}
2.1.17.4 - 1.0
get /v1/cloud-functions/sample-codes
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
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SampleCodesListResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/sample-codes
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.0"
Example HTTP response
Response 200
{
"count": "3",
"sample_codes": [
{
"content": "sample",
"default": false,
"description": "sample",
"name": "sample",
"runtime": "Node.js:20",
"seq": "3",
"version": "sample"
}
]
}
2.1.18 - Request PrivateLink Endpoint
2.1.18.1 - 1.3
put /v1/cloud-functions/{cloud_function_id}/configurations/privatelink-endpoints/{endpoint_id}/request
Description
request privatelink endpoint
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| path | endpoint_id required | Endpoint Id Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| body | body required | PrivateLinkEndpointRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PrivateLinkEndpoint |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/configurations/privatelink-endpoints/{endpoint_id}/request
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.3"
Request body
{
"type": "CANCEL"
}
Example HTTP response
Response 200
{
"endpoint": {
"endpoint_alias": "sample",
"endpoint_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"service_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"state": "Active"
}
}
2.1.18.2 - 1.2
put /v1/cloud-functions/{cloud_function_id}/configurations/privatelink-endpoints/{endpoint_id}/request
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| path | endpoint_id required | Endpoint Id Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| body | body required | PrivateLinkEndpointRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PrivateLinkEndpoint |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/configurations/privatelink-endpoints/{endpoint_id}/request
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.2"
Request body
{
"type": "CANCEL"
}
Example HTTP response
Response 200
{
"endpoint": {
"endpoint_alias": "sample",
"endpoint_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"service_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"state": "Active"
}
}
2.1.19 - Set Resource Policy
2.1.19.1 - 1.3
put /v1/cloud-functions/{cloud_function_id}/configurations/resource-policies
Description
Set resource policy
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| body | body required | ResourcePolicySetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ResourcePolicyShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/configurations/resource-policies
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.3"
Request body
{
"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"
}
}
Example HTTP response
Response 200
{
"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.20 - Show Cloud Function
2.1.20.1 - 1.3
get /v1/cloud-functions/{cloud_function_id}
Description
show a specific cloud_function
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | CloudFunctionShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.3"
Example HTTP response
Response 200
{
"cloud_function": {
"account_id": "617b3d0e90c24a5fa1f65a3824861354",
"function_url": "https://33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/cloudfunctions-hello",
"id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"name": "sample",
"runtime": "Node.js:20",
"state": "READY",
"user_id": "617b3d0e90c24a5fa1f65a3824861354"
}
}
2.1.20.2 - 1.2
get /v1/cloud-functions/{cloud_function_id}
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | CloudFunctionShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.2"
Example HTTP response
Response 200
{
"cloud_function": {
"account_id": "617b3d0e90c24a5fa1f65a3824861354",
"function_url": "https://33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/cloudfunctions-hello",
"id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"name": "sample",
"runtime": "Node.js:20",
"state": "READY",
"user_id": "617b3d0e90c24a5fa1f65a3824861354"
}
}
2.1.20.3 - 1.1
get /v1/cloud-functions/{cloud_function_id}
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | CloudFunctionShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.1"
Example HTTP response
Response 200
{
"cloud_function": {
"account_id": "617b3d0e90c24a5fa1f65a3824861354",
"function_url": "https://33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/cloudfunctions-hello",
"id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"name": "sample",
"runtime": "Node.js:20",
"state": "READY",
"user_id": "617b3d0e90c24a5fa1f65a3824861354"
}
}
2.1.20.4 - 1.0
get /v1/cloud-functions/{cloud_function_id}
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | CloudFunctionShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.0"
Example HTTP response
Response 200
{
"cloud_function": {
"account_id": "617b3d0e90c24a5fa1f65a3824861354",
"function_url": "https://33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/cloudfunctions-hello",
"id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"name": "sample",
"runtime": "Node.js:20",
"state": "READY",
"user_id": "617b3d0e90c24a5fa1f65a3824861354"
}
}
2.1.21 - Show Cloud Function Code
2.1.21.1 - 1.3
get /v1/cloud-functions/{cloud_function_id}/codes
Description
show a specific cloud_function code
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | Code |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/codes
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.3"
Example HTTP response
Response 200
{
"class_name": "com.example.Handler",
"code_text": "ZXhwb3J0cy5oYW5kbGVSZXF1ZXN0ID0gYXN5bmM==",
"code_type": "text",
"file_name": "sample",
"file_transfer_status": "sample",
"file_upload_at": "2025-05-17 00:23:17",
"method_name": "handleRequest",
"runtime": "Node.js:20"
}
2.1.21.2 - 1.2
get /v1/cloud-functions/{cloud_function_id}/codes
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | Code |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/codes
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.2"
Example HTTP response
Response 200
{
"class_name": "com.example.Handler",
"code_text": "ZXhwb3J0cy5oYW5kbGVSZXF1ZXN0ID0gYXN5bmM==",
"code_type": "text",
"file_name": "sample",
"file_transfer_status": "sample",
"file_upload_at": "2025-05-17 00:23:17",
"method_name": "handleRequest",
"runtime": "Node.js:20"
}
2.1.21.3 - 1.1
get /v1/cloud-functions/{cloud_function_id}/codes
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | Code |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/codes
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.1"
Example HTTP response
Response 200
{
"class_name": "com.example.Handler",
"code_text": "ZXhwb3J0cy5oYW5kbGVSZXF1ZXN0ID0gYXN5bmM==",
"code_type": "text",
"file_name": "sample",
"file_transfer_status": "sample",
"file_upload_at": "2025-05-17 00:23:17",
"method_name": "handleRequest",
"runtime": "Node.js:20"
}
2.1.21.4 - 1.0
get /v1/cloud-functions/{cloud_function_id}/codes
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | Code |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/codes
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.0"
Example HTTP response
Response 200
{
"class_name": "com.example.Handler",
"code_text": "ZXhwb3J0cy5oYW5kbGVSZXF1ZXN0ID0gYXN5bmM==",
"code_type": "text",
"file_name": "sample",
"file_transfer_status": "sample",
"file_upload_at": "2025-05-17 00:23:17",
"method_name": "handleRequest",
"runtime": "Node.js:20"
}
2.1.22 - Show Cloud Function Configuration
2.1.22.1 - 1.3
get /v1/cloud-functions/{cloud_function_id}/configurations
Description
show a specific cloud-function configuration
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ConfigurationV1Dot2 |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/configurations
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.3"
Example HTTP response
Response 200
{
"config": {
"max_scale": "5",
"memory": "256",
"min_scale": "1",
"timeout": "100"
},
"privatelink_endpoints": [],
"privatelink_service": {
"private_url": "https://sample.scf.private.kr-west1.e.samsungsdscloud.com",
"privatelink_service_enabled": true,
"privatelink_service_id": "ba30549f550141ef9af6546543s",
"privatelink_service_name": "68216f8f56",
"requested_endpoints": []
},
"url": {
"allow_ips": [
""
],
"auth_type": "NONE",
"public_endpoint_url": "https://scf.33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/sample-function",
"public_ip_acl_enabled": true,
"url_enabled": true
},
"variables": [
{
"key": "sample",
"value": "sample"
}
]
}
2.1.22.2 - 1.2
get /v1/cloud-functions/{cloud_function_id}/configurations
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ConfigurationV1Dot2 |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/configurations
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.2"
Example HTTP response
Response 200
{
"config": {
"max_scale": "5",
"memory": "256",
"min_scale": "1",
"timeout": "100"
},
"privatelink_endpoints": [],
"privatelink_service": {
"private_url": "https://sample.scf.private.kr-west1.e.samsungsdscloud.com",
"privatelink_service_enabled": true,
"privatelink_service_id": "ba30549f550141ef9af6546543s",
"privatelink_service_name": "68216f8f56",
"requested_endpoints": []
},
"url": {
"allow_ips": [
""
],
"auth_type": "NONE",
"public_endpoint_url": "https://scf.33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/sample-function",
"public_ip_acl_enabled": true,
"url_enabled": true
},
"variables": [
{
"key": "sample",
"value": "sample"
}
]
}
2.1.22.3 - 1.1
get /v1/cloud-functions/{cloud_function_id}/configurations
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | Configuration |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/configurations
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.1"
Example HTTP response
Response 200
{
"config": {
"max_scale": "5",
"memory": "256",
"min_scale": "1",
"timeout": "100"
},
"url": {
"allow_ips": [
""
],
"auth_type": "NONE",
"public_endpoint_url": "https://scf.33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/sample-function",
"public_ip_acl_enabled": true,
"url_enabled": true
},
"variables": [
{
"key": "sample",
"value": "sample"
}
]
}
2.1.22.4 - 1.0
get /v1/cloud-functions/{cloud_function_id}/configurations
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | Configuration |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/configurations
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.0"
Example HTTP response
Response 200
{
"config": {
"max_scale": "5",
"memory": "256",
"min_scale": "1",
"timeout": "100"
},
"url": {
"allow_ips": [
""
],
"auth_type": "NONE",
"public_endpoint_url": "https://scf.33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/sample-function",
"public_ip_acl_enabled": true,
"url_enabled": true
},
"variables": [
{
"key": "sample",
"value": "sample"
}
]
}
2.1.23 - Show Cloud Function Logs
2.1.23.1 - 1.3
get /v1/cloud-functions/{cloud_function_id}/logs
Description
show a specific cloud-function logs
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| query | time optional | Time Example : 3 | any of [integer, null] | None |
| query | start optional | Start Example : 20250517 | any of [string, null] | None |
| query | end optional | End Example : 20250517 | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | LogShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/logs
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.3"
Example HTTP response
Response 200
{
"count": "3",
"logs": [
{
"log": "[2025-05-12 11:04:12] START RequestId : 04680bac - ad76-4e0a-997e-e35b6275cb67 Version : $LATEST",
"time": "2025-05-17 00:23:17"
}
]
}
2.1.23.2 - 1.2
get /v1/cloud-functions/{cloud_function_id}/logs
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| query | time optional | Time Example : 3 | any of [integer, null] | None |
| query | start optional | Start Example : 20250517 | any of [string, null] | None |
| query | end optional | End Example : 20250517 | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | LogShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/logs
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.2"
Example HTTP response
Response 200
{
"count": "3",
"logs": [
{
"log": "[2025-05-12 11:04:12] START RequestId : 04680bac - ad76-4e0a-997e-e35b6275cb67 Version : $LATEST",
"time": "2025-05-17 00:23:17"
}
]
}
2.1.23.3 - 1.1
get /v1/cloud-functions/{cloud_function_id}/logs
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| query | time optional | Time Example : 3 | any of [integer, null] | None |
| query | start optional | Start Example : 20250517 | any of [string, null] | None |
| query | end optional | End Example : 20250517 | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | LogShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/logs
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.1"
Example HTTP response
Response 200
{
"count": "3",
"logs": [
{
"log": "[2025-05-12 11:04:12] START RequestId : 04680bac - ad76-4e0a-997e-e35b6275cb67 Version : $LATEST",
"time": "2025-05-17 00:23:17"
}
]
}
2.1.23.4 - 1.0
get /v1/cloud-functions/{cloud_function_id}/logs
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| query | time optional | Time Example : 3 | any of [integer, null] | None |
| query | start optional | Start Example : 20250517 | any of [string, null] | None |
| query | end optional | End Example : 20250517 | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | LogShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/logs
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.0"
Example HTTP response
Response 200
{
"count": "3",
"logs": [
{
"log": "[2025-05-12 11:04:12] START RequestId : 04680bac - ad76-4e0a-997e-e35b6275cb67 Version : $LATEST",
"time": "2025-05-17 00:23:17"
}
]
}
2.1.24 - Show Cloud Function Metrics
2.1.24.1 - 1.3
get /v1/cloud-functions/{cloud_function_id}/metrics
Description
show a specific cloud-function metrics
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| query | time optional | Time Example : 3 | any of [integer, null] | None |
| query | start optional | Start Example : 20250517 | any of [string, null] | None |
| query | end optional | End Example : 20250517 | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | MetricShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/metrics
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.3"
Example HTTP response
Response 200
{
"actual_pods": [
{
"metric_data": "1.0033444816053512",
"time": "16:37"
}
],
"fail_count": [
{
"metric_data": "1.0033444816053512",
"time": "16:37"
}
],
"function_memory": [
{
"metric_data": "1.0033444816053512",
"time": "16:37"
}
],
"request_count": [
{
"metric_data": "1.0033444816053512",
"time": "16:37"
}
],
"request_latency": [
{
"metric_data": "1.0033444816053512",
"time": "16:37"
}
],
"success_count": [
{
"metric_data": "1.0033444816053512",
"time": "16:37"
}
]
}
2.1.24.2 - 1.2
get /v1/cloud-functions/{cloud_function_id}/metrics
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| query | time optional | Time Example : 3 | any of [integer, null] | None |
| query | start optional | Start Example : 20250517 | any of [string, null] | None |
| query | end optional | End Example : 20250517 | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | MetricShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/metrics
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.2"
Example HTTP response
Response 200
{
"actual_pods": [
{
"metric_data": "1.0033444816053512",
"time": "16:37"
}
],
"fail_count": [
{
"metric_data": "1.0033444816053512",
"time": "16:37"
}
],
"function_memory": [
{
"metric_data": "1.0033444816053512",
"time": "16:37"
}
],
"request_count": [
{
"metric_data": "1.0033444816053512",
"time": "16:37"
}
],
"request_latency": [
{
"metric_data": "1.0033444816053512",
"time": "16:37"
}
],
"success_count": [
{
"metric_data": "1.0033444816053512",
"time": "16:37"
}
]
}
2.1.24.3 - 1.1
get /v1/cloud-functions/{cloud_function_id}/metrics
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| query | time optional | Time Example : 3 | any of [integer, null] | None |
| query | start optional | Start Example : 20250517 | any of [string, null] | None |
| query | end optional | End Example : 20250517 | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | MetricShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/metrics
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.1"
Example HTTP response
Response 200
{
"actual_pods": [
{
"metric_data": "1.0033444816053512",
"time": "16:37"
}
],
"fail_count": [
{
"metric_data": "1.0033444816053512",
"time": "16:37"
}
],
"function_memory": [
{
"metric_data": "1.0033444816053512",
"time": "16:37"
}
],
"request_count": [
{
"metric_data": "1.0033444816053512",
"time": "16:37"
}
],
"request_latency": [
{
"metric_data": "1.0033444816053512",
"time": "16:37"
}
],
"success_count": [
{
"metric_data": "1.0033444816053512",
"time": "16:37"
}
]
}
2.1.24.4 - 1.0
get /v1/cloud-functions/{cloud_function_id}/metrics
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| query | time optional | Time Example : 3 | any of [integer, null] | None |
| query | start optional | Start Example : 20250517 | any of [string, null] | None |
| query | end optional | End Example : 20250517 | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | MetricShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/metrics
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.0"
Example HTTP response
Response 200
{
"actual_pods": [
{
"metric_data": "1.0033444816053512",
"time": "16:37"
}
],
"fail_count": [
{
"metric_data": "1.0033444816053512",
"time": "16:37"
}
],
"function_memory": [
{
"metric_data": "1.0033444816053512",
"time": "16:37"
}
],
"request_count": [
{
"metric_data": "1.0033444816053512",
"time": "16:37"
}
],
"request_latency": [
{
"metric_data": "1.0033444816053512",
"time": "16:37"
}
],
"success_count": [
{
"metric_data": "1.0033444816053512",
"time": "16:37"
}
]
}
2.1.25 - Show Cloud Function Trigger
2.1.25.1 - 1.3
get /v1/triggers/{trigger_id}
Description
show a specific cloud-function trigger
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | trigger_id required | Trigger ID Example : 1 | integer | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | Trigger |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/triggers/{trigger_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.3"
Example HTTP response
Response 200
{
"alias": "$LATEST",
"schedule": "* * * * 0",
"timezone": "Asia/Tokyo",
"trigger_id": 1,
"trigger_name": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_sid": "617b3d0e90c24a5fa1f65a3824861354",
"trigger_target_account_id": "617b3d0e90c24a5fa1f65a3824861354",
"trigger_target_srn": "srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe",
"trigger_target_uuid": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_type": "apigateway"
}
2.1.25.2 - 1.2
get /v1/triggers/{trigger_id}
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | trigger_id required | Trigger ID Example : 1 | integer | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | Trigger |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/triggers/{trigger_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.2"
Example HTTP response
Response 200
{
"alias": "$LATEST",
"schedule": "* * * * 0",
"timezone": "Asia/Tokyo",
"trigger_id": 1,
"trigger_name": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_sid": "617b3d0e90c24a5fa1f65a3824861354",
"trigger_target_account_id": "617b3d0e90c24a5fa1f65a3824861354",
"trigger_target_srn": "srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe",
"trigger_target_uuid": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_type": "apigateway"
}
2.1.25.3 - 1.1
get /v1/triggers/{trigger_id}
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | trigger_id required | Trigger ID Example : 1 | integer | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | Trigger |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/triggers/{trigger_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.1"
Example HTTP response
Response 200
{
"alias": "$LATEST",
"schedule": "* * * * 0",
"timezone": "Asia/Tokyo",
"trigger_id": 1,
"trigger_name": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_sid": "617b3d0e90c24a5fa1f65a3824861354",
"trigger_target_account_id": "617b3d0e90c24a5fa1f65a3824861354",
"trigger_target_srn": "srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe",
"trigger_target_uuid": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_type": "apigateway"
}
2.1.25.4 - 1.0
get /v1/triggers/{trigger_id}
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | trigger_id required | Trigger ID Example : 1 | integer | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | Trigger |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/triggers/{trigger_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.0"
Example HTTP response
Response 200
{
"alias": "$LATEST",
"schedule": "* * * * 0",
"timezone": "Asia/Tokyo",
"trigger_id": 1,
"trigger_name": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_sid": "617b3d0e90c24a5fa1f65a3824861354",
"trigger_target_account_id": "617b3d0e90c24a5fa1f65a3824861354",
"trigger_target_srn": "srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe",
"trigger_target_uuid": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_type": "apigateway"
}
2.1.26 - Show General Config
2.1.26.1 - 1.3
get /v1/cloud-functions/{cloud_function_id}/configurations/config
Description
show general config
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | FunctionConfig |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/configurations/config
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.3"
Example HTTP response
Response 200
{
"max_scale": "5",
"memory": "256",
"min_scale": "1",
"timeout": "100"
}
2.1.27 - Show PrivateLink Service
2.1.27.1 - 1.3
get /v1/cloud-functions/{cloud_function_id}/configurations/privatelink-services
Description
show PrivateLink Service
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| query | sort optional | Sort Example : endpoint_id:asc | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PrivateLinkServiceV1Dot3 |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/configurations/privatelink-services
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.3"
Example HTTP response
Response 200
{
"private_url": "https://sample.scf.private.kr-west1.e.samsungsdscloud.com",
"privatelink_service_auth_type": "SCP_IAM",
"privatelink_service_enabled": true,
"privatelink_service_id": "ba30549f550141ef9af6546543s",
"privatelink_service_name": "68216f8f56",
"privatelink_service_state": "Active",
"requested_endpoints": []
}
2.1.28 - Show Resource Policy
2.1.28.1 - 1.3
get /v1/cloud-functions/{cloud_function_id}/configurations/resource-policies
Description
Show resource policy
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ResourcePolicyShowResponse |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/configurations/resource-policies
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.3"
Example HTTP response
Response 200
{
"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
get /v1/cloud-functions/{cloud_function_id}/configurations/url
Description
show url config
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | FunctionUrlV1Dot3 |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/configurations/url
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.3"
Example HTTP response
Response 200
{
"allow_ips": [
""
],
"auth_type": "NONE",
"public_endpoint_url": "https://scf.33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/sample-function",
"public_ip_acl_enabled": true,
"state": "CREATING",
"url_enabled": true
}
2.1.30 - Update Cloud Function Code
2.1.30.1 - 1.3
put /v1/cloud-functions/{cloud_function_id}/codes
Description
update cloud-function code
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| body | body required | CodeSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | Code |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/codes
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.3"
Request body
{
"content": "print(\"Hello World\")"
}
Example HTTP response
Response 202
{
"class_name": "com.example.Handler",
"code_text": "ZXhwb3J0cy5oYW5kbGVSZXF1ZXN0ID0gYXN5bmM==",
"code_type": "text",
"file_name": "sample",
"file_transfer_status": "sample",
"file_upload_at": "2025-05-17 00:23:17",
"method_name": "handleRequest",
"runtime": "Node.js:20"
}
2.1.30.2 - 1.2
put /v1/cloud-functions/{cloud_function_id}/codes
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| body | body required | CodeSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | Code |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/codes
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.2"
Request body
{
"content": "print(\"Hello World\")"
}
Example HTTP response
Response 202
{
"class_name": "com.example.Handler",
"code_text": "ZXhwb3J0cy5oYW5kbGVSZXF1ZXN0ID0gYXN5bmM==",
"code_type": "text",
"file_name": "sample",
"file_transfer_status": "sample",
"file_upload_at": "2025-05-17 00:23:17",
"method_name": "handleRequest",
"runtime": "Node.js:20"
}
2.1.30.3 - 1.1
put /v1/cloud-functions/{cloud_function_id}/codes
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| body | body required | CodeSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | Code |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/codes
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.1"
Request body
{
"content": "print(\"Hello World\")"
}
Example HTTP response
Response 202
{
"class_name": "com.example.Handler",
"code_text": "ZXhwb3J0cy5oYW5kbGVSZXF1ZXN0ID0gYXN5bmM==",
"code_type": "text",
"file_name": "sample",
"file_transfer_status": "sample",
"file_upload_at": "2025-05-17 00:23:17",
"method_name": "handleRequest",
"runtime": "Node.js:20"
}
2.1.30.4 - 1.0
put /v1/cloud-functions/{cloud_function_id}/codes
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| body | body required | CodeSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | Code |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/codes
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.0"
Request body
{
"content": "print(\"Hello World\")"
}
Example HTTP response
Response 202
{
"class_name": "com.example.Handler",
"code_text": "ZXhwb3J0cy5oYW5kbGVSZXF1ZXN0ID0gYXN5bmM==",
"code_type": "text",
"file_name": "sample",
"file_transfer_status": "sample",
"file_upload_at": "2025-05-17 00:23:17",
"method_name": "handleRequest",
"runtime": "Node.js:20"
}
2.1.31 - Update Cloud Function Code File
2.1.31.1 - 1.3
put /v1/cloud-functions/{cloud_function_id}/codes/file
Description
update a specific cloud_function code file
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| body | body required | CodeFile |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | Code |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/codes/file
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.3"
Request body
{
"class_name": "com.example.Handler",
"method_name": "handleRequest",
"obs_url": "https://obs.kr-east1.scp-in.com:8443/sample/java-sample-1.0-SNAPSHOT.jar"
}
Example HTTP response
Response 202
{
"class_name": "com.example.Handler",
"code_text": "ZXhwb3J0cy5oYW5kbGVSZXF1ZXN0ID0gYXN5bmM==",
"code_type": "text",
"file_name": "sample",
"file_transfer_status": "sample",
"file_upload_at": "2025-05-17 00:23:17",
"method_name": "handleRequest",
"runtime": "Node.js:20"
}
2.1.31.2 - 1.2
put /v1/cloud-functions/{cloud_function_id}/codes/file
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| body | body required | CodeFile |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | Code |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/codes/file
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.2"
Request body
{
"class_name": "com.example.Handler",
"method_name": "handleRequest",
"obs_url": "https://obs.kr-east1.scp-in.com:8443/sample/java-sample-1.0-SNAPSHOT.jar"
}
Example HTTP response
Response 202
{
"class_name": "com.example.Handler",
"code_text": "ZXhwb3J0cy5oYW5kbGVSZXF1ZXN0ID0gYXN5bmM==",
"code_type": "text",
"file_name": "sample",
"file_transfer_status": "sample",
"file_upload_at": "2025-05-17 00:23:17",
"method_name": "handleRequest",
"runtime": "Node.js:20"
}
2.1.31.3 - 1.1
put /v1/cloud-functions/{cloud_function_id}/codes/file
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| body | body required | CodeFile |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | Code |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/codes/file
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.1"
Request body
{
"class_name": "com.example.Handler",
"method_name": "handleRequest",
"obs_url": "https://obs.kr-east1.scp-in.com:8443/sample/java-sample-1.0-SNAPSHOT.jar"
}
Example HTTP response
Response 202
{
"class_name": "com.example.Handler",
"code_text": "ZXhwb3J0cy5oYW5kbGVSZXF1ZXN0ID0gYXN5bmM==",
"code_type": "text",
"file_name": "sample",
"file_transfer_status": "sample",
"file_upload_at": "2025-05-17 00:23:17",
"method_name": "handleRequest",
"runtime": "Node.js:20"
}
2.1.32 - Update Cloud Function Config
2.1.32.1 - 1.3
put /v1/cloud-functions/{cloud_function_id}/configurations/config
Description
update cloud-function config
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| body | body required | FunctionConfig |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | FunctionConfig |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/configurations/config
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.3"
Request body
{
"max_scale": "5",
"memory": "256",
"min_scale": "1",
"timeout": "100"
}
Example HTTP response
Response 200
{
"max_scale": "5",
"memory": "256",
"min_scale": "1",
"timeout": "100"
}
2.1.32.2 - 1.2
put /v1/cloud-functions/{cloud_function_id}/configurations/config
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| body | body required | FunctionConfig |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | FunctionConfig |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/configurations/config
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.2"
Request body
{
"max_scale": "5",
"memory": "256",
"min_scale": "1",
"timeout": "100"
}
Example HTTP response
Response 200
{
"max_scale": "5",
"memory": "256",
"min_scale": "1",
"timeout": "100"
}
2.1.32.3 - 1.1
put /v1/cloud-functions/{cloud_function_id}/configurations/config
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| body | body required | FunctionConfig |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | FunctionConfig |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/configurations/config
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.1"
Request body
{
"max_scale": "5",
"memory": "256",
"min_scale": "1",
"timeout": "100"
}
Example HTTP response
Response 200
{
"max_scale": "5",
"memory": "256",
"min_scale": "1",
"timeout": "100"
}
2.1.32.4 - 1.0
put /v1/cloud-functions/{cloud_function_id}/configurations/config
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| body | body required | FunctionConfig |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | FunctionConfig |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/configurations/config
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.0"
Request body
{
"max_scale": "5",
"memory": "256",
"min_scale": "1",
"timeout": "100"
}
Example HTTP response
Response 200
{
"max_scale": "5",
"memory": "256",
"min_scale": "1",
"timeout": "100"
}
2.1.33 - Update Cloud Function Cronjob Trigger
2.1.33.1 - 1.3
put /v1/triggers/cronjob/{trigger_id}
Description
update cloud-function cronjob trigger
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | trigger_id required | Trigger ID Example : 1 | integer | None |
| body | body required | CronjobTriggerSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | TriggerUpdateResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/triggers/cronjob/{trigger_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.3"
Request body
{
"cloud_function_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"schedule": "* * * * 0",
"timezone": "Asia/Tokyo"
}
Example HTTP response
Response 200
{
"alias": "$LATEST",
"cloud_function_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"triggers": [
{
"schedule": "* * * * 0",
"timezone": "Asia/Tokyo",
"trigger_id": 1,
"trigger_name": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_target_account_id": "617b3d0e90c24a5fa1f65a3824861354",
"trigger_target_srn": "srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe",
"trigger_target_uuid": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_type": "apigateway"
}
]
}
2.1.33.2 - 1.2
put /v1/triggers/cronjob/{trigger_id}
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | trigger_id required | Trigger ID Example : 1 | integer | None |
| body | body required | CronjobTriggerSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | TriggerUpdateResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/triggers/cronjob/{trigger_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.2"
Request body
{
"cloud_function_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"schedule": "* * * * 0",
"timezone": "Asia/Tokyo"
}
Example HTTP response
Response 200
{
"alias": "$LATEST",
"cloud_function_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"triggers": [
{
"schedule": "* * * * 0",
"timezone": "Asia/Tokyo",
"trigger_id": 1,
"trigger_name": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_target_account_id": "617b3d0e90c24a5fa1f65a3824861354",
"trigger_target_srn": "srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe",
"trigger_target_uuid": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_type": "apigateway"
}
]
}
2.1.33.3 - 1.1
put /v1/triggers/cronjob/{trigger_id}
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | trigger_id required | Trigger ID Example : 1 | integer | None |
| body | body required | CronjobTriggerSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | TriggerUpdateResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/triggers/cronjob/{trigger_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.1"
Request body
{
"cloud_function_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"schedule": "* * * * 0",
"timezone": "Asia/Tokyo"
}
Example HTTP response
Response 200
{
"alias": "$LATEST",
"cloud_function_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"triggers": [
{
"schedule": "* * * * 0",
"timezone": "Asia/Tokyo",
"trigger_id": 1,
"trigger_name": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_target_account_id": "617b3d0e90c24a5fa1f65a3824861354",
"trigger_target_srn": "srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe",
"trigger_target_uuid": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_type": "apigateway"
}
]
}
2.1.33.4 - 1.0
put /v1/triggers/cronjob/{trigger_id}
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | trigger_id required | Trigger ID Example : 1 | integer | None |
| body | body required | CronjobTriggerSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | TriggerUpdateResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/triggers/cronjob/{trigger_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.0"
Request body
{
"cloud_function_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"schedule": "* * * * 0",
"timezone": "Asia/Tokyo"
}
Example HTTP response
Response 200
{
"alias": "$LATEST",
"cloud_function_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"triggers": [
{
"schedule": "* * * * 0",
"timezone": "Asia/Tokyo",
"trigger_id": 1,
"trigger_name": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_target_account_id": "617b3d0e90c24a5fa1f65a3824861354",
"trigger_target_srn": "srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe",
"trigger_target_uuid": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_type": "apigateway"
}
]
}
2.1.34 - Update Cloud Function Url
2.1.34.1 - 1.3
put /v1/cloud-functions/{cloud_function_id}/configurations/url
Description
update cloud-function url
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| body | body required | FunctionUrlRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | FunctionUrlV1Dot3 |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/configurations/url
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.3"
Request body
{
"allow_ips": [],
"auth_type": "NONE",
"public_ip_acl_enabled": true,
"url_enabled": true
}
Example HTTP response
Response 200
{
"allow_ips": [
""
],
"auth_type": "NONE",
"public_endpoint_url": "https://scf.33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/sample-function",
"public_ip_acl_enabled": true,
"state": "CREATING",
"url_enabled": true
}
2.1.34.2 - 1.2
put /v1/cloud-functions/{cloud_function_id}/configurations/url
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| body | body required | FunctionUrlRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | FunctionUrl |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/configurations/url
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.2"
Request body
{
"allow_ips": [],
"auth_type": "NONE",
"public_ip_acl_enabled": true,
"url_enabled": true
}
Example HTTP response
Response 200
{
"allow_ips": [
""
],
"auth_type": "NONE",
"public_endpoint_url": "https://scf.33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/sample-function",
"public_ip_acl_enabled": true,
"url_enabled": true
}
2.1.34.3 - 1.1
put /v1/cloud-functions/{cloud_function_id}/configurations/url
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| body | body required | FunctionUrlRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | FunctionUrl |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/configurations/url
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.1"
Request body
{
"allow_ips": [],
"auth_type": "NONE",
"public_ip_acl_enabled": true,
"url_enabled": true
}
Example HTTP response
Response 200
{
"allow_ips": [
""
],
"auth_type": "NONE",
"public_endpoint_url": "https://scf.33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/sample-function",
"public_ip_acl_enabled": true,
"url_enabled": true
}
2.1.34.4 - 1.0
put /v1/cloud-functions/{cloud_function_id}/configurations/url
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| body | body required | FunctionUrlRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | FunctionUrl |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/configurations/url
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.0"
Request body
{
"allow_ips": [],
"auth_type": "NONE",
"public_ip_acl_enabled": true,
"url_enabled": true
}
Example HTTP response
Response 200
{
"allow_ips": [
""
],
"auth_type": "NONE",
"public_endpoint_url": "https://scf.33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/sample-function",
"public_ip_acl_enabled": true,
"url_enabled": true
}
2.1.35 - Update Cloud Function Variables
2.1.35.1 - 1.3
put /v1/cloud-functions/{cloud_function_id}/configurations/environment-variables
Description
update cloud-function variables
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| body | body required | FunctionVariables |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | FunctionVariables |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/configurations/environment-variables
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.3"
Request body
{
"variables": [
{
"key": "sample",
"value": "sample"
}
]
}
Example HTTP response
Response 200
{
"variables": [
{
"key": "sample",
"value": "sample"
}
]
}
2.1.35.2 - 1.2
put /v1/cloud-functions/{cloud_function_id}/configurations/environment-variables
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| body | body required | FunctionVariables |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | FunctionVariables |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/configurations/environment-variables
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.2"
Request body
{
"variables": [
{
"key": "sample",
"value": "sample"
}
]
}
Example HTTP response
Response 200
{
"variables": [
{
"key": "sample",
"value": "sample"
}
]
}
2.1.35.3 - 1.1
put /v1/cloud-functions/{cloud_function_id}/configurations/environment-variables
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| body | body required | FunctionVariables |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | FunctionVariables |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/configurations/environment-variables
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.1"
Request body
{
"variables": [
{
"key": "sample",
"value": "sample"
}
]
}
Example HTTP response
Response 200
{
"variables": [
{
"key": "sample",
"value": "sample"
}
]
}
2.1.35.4 - 1.0
put /v1/cloud-functions/{cloud_function_id}/configurations/environment-variables
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| body | body required | FunctionVariables |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | FunctionVariables |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/configurations/environment-variables
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.0"
Request body
{
"variables": [
{
"key": "sample",
"value": "sample"
}
]
}
Example HTTP response
Response 200
{
"variables": [
{
"key": "sample",
"value": "sample"
}
]
}
2.1.36 - Update PrivateLink Service
2.1.36.1 - 1.3
put /v1/cloud-functions/{cloud_function_id}/configurations/privatelink-services
Description
update PrivateLink Service
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| body | body required | PrivateLinkServicePutRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | PrivateLinkServiceV1Dot3 |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/configurations/privatelink-services
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.3"
Request body
{
"privatelink_service_enabled": true
}
Example HTTP response
Response 202
{
"private_url": "https://sample.scf.private.kr-west1.e.samsungsdscloud.com",
"privatelink_service_auth_type": "SCP_IAM",
"privatelink_service_enabled": true,
"privatelink_service_id": "ba30549f550141ef9af6546543s",
"privatelink_service_name": "68216f8f56",
"privatelink_service_state": "Active",
"requested_endpoints": []
}
2.1.36.2 - 1.2
put /v1/cloud-functions/{cloud_function_id}/configurations/privatelink-services
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| body | body required | PrivateLinkServicePutRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | PrivateLinkService |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/configurations/privatelink-services
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.2"
Request body
{
"privatelink_service_enabled": true
}
Example HTTP response
Response 202
{
"private_url": "https://sample.scf.private.kr-west1.e.samsungsdscloud.com",
"privatelink_service_enabled": true,
"privatelink_service_id": "ba30549f550141ef9af6546543s",
"privatelink_service_name": "68216f8f56",
"requested_endpoints": []
}
2.2 - Models
2.2.1 - ApigatewayTriggerCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| apigateway_api_id required | Apigateway API ID Example : 31e749b7b260868f441e862bPattern : ^[0-9a-f]{24}$ | string | |
| apigateway_stage_name required | Apigateway Stage Name Example : samplePattern : ^[a-z0-9\-]+$ | string | |
| cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656Pattern : ^[0-9a-f]{32}$ | string |
2.2.2 - CloudFunction
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : 617b3d0e90c24a5fa1f65a3824861354 | string | |
| function_url required | Cloud function Url Example : https://33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/cloudfunctions-hello | any of [string, null] | |
| id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | |
| name required | Cloud Functions name Example : sample | string | |
| runtime required | Runtime Example : Node.js:20 | string | |
| state required | Cloud function state Example : READY | string | |
| user_id required | User ID Example : 617b3d0e90c24a5fa1f65a3824861354 | string |
2.2.3 - CloudFunctionCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| content required | Code content Example : sample | string | |
| name required | Name Example : sample-function-namePattern : ^[a-z][a-z0-9-]*$Minimum length : 3Maximum length : 64 | string | |
| runtime required | Runtime Example : Node.js:20 | string | |
| tags optional | Tag List | any of [array[Tag], null] |
2.2.4 - CloudFunctionCreateResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | |
| message required | Description Example : Description | string | |
| state required | Cloud function state Example : READY | string |
2.2.5 - CloudFunctionForList
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : 617b3d0e90c24a5fa1f65a3824861354 | string | |
| created_at required | Created At Example : 2025-05-22T06:21:17.580522 | string (date-time) | |
| function_url required | Cloud function Url Example : https://33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/cloudfunctions-hello | any of [string, null] | |
| id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | |
| name required | Cloud Functions name Example : sample | string | |
| runtime required | Runtime Example : Node.js:20 | string | |
| state required | Cloud function state Example : READY | string | |
| user_id required | User ID Example : 617b3d0e90c24a5fa1f65a3824861354 | string |
2.2.6 - CloudFunctionListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| cloud_functions required | Contents | array[CloudFunctionForList] | |
| count required | Count Example : 20 | integer |
2.2.7 - CloudFunctionShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| cloud_function required | CloudFunction |
2.2.8 - Code
| Name | Description | Schema | Default |
|---|---|---|---|
| class_name optional | Class Name Example : com.example.Handler | any of [string, null] | |
| code_text optional | Code Text Example : ZXhwb3J0cy5oYW5kbGVSZXF1ZXN0ID0gYXN5bmM== | any of [string, null] | |
| code_type required | Code Type Example : text | string | |
| file_name optional | File Name Example : sample | any of [string, null] | |
| file_transfer_status optional | File Transfer Status Example : sample | any of [string, null] | |
| file_upload_at optional | File Upload At Example : 2025-05-17 00:23:17 | any of [string, null] | |
| method_name optional | Method Name Example : handleRequest | any of [string, null] | |
| runtime required | Runtime Example : Node.js:20 | string |
2.2.9 - CodeFile
| Name | Description | Schema | Default |
|---|---|---|---|
| class_name required | Class Name Example : com.example.Handler | string | |
| method_name required | Method Name Example : handleRequest | string | |
| obs_url optional | Object Storage URL Example : https://obs.kr-east1.scp-in.com:8443/sample/java-sample-1.0-SNAPSHOT.jar | any of [string, null] |
2.2.10 - CodeSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| content required | Code content Example : print("Hello World") | string |
2.2.11 - Configuration
| Name | Description | Schema | Default |
|---|---|---|---|
| config required | Configuration | FunctionConfig | |
| url required | Function URL | FunctionUrl | |
| variables optional | Environment Variables | any of [array[FunctionVariable], null] |
2.2.12 - ConfigurationV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| config required | Configuration | FunctionConfig | |
| privatelink_endpoints optional | Endpoints | any of [array[Endpoint], null] | |
| privatelink_service optional | PrivateLink Service | any of [PrivateLinkService, null] | |
| url required | Function URL | FunctionUrl | |
| variables optional | Environment Variables | any of [array[FunctionVariable], null] |
2.2.13 - CronjobTriggerCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656Pattern : ^[0-9a-f]{32}$ | string | |
| schedule required | Schedule Example : * * * * 0 | string | |
| timezone required | Timezone Example : Asia/Tokyo | string |
2.2.14 - CronjobTriggerSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656Pattern : ^[0-9a-f]{32}$ | string | |
| schedule required | Schedule Example : * * * * 0 | string | |
| timezone required | Timezone Example : Asia/Tokyo | string |
2.2.15 - DuplicationShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| result required | Result Example : True | boolean |
2.2.16 - Endpoint
| Name | Description | Schema | Default |
|---|---|---|---|
| endpoint_alias optional | Alias Example : sample | any of [string, null] | |
| endpoint_id required | Endpoint Id Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | |
| service_id optional | Service Id Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | any of [string, null] | |
| state required | State Example : Active | string |
2.2.17 - EndpointCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| alias required | Alias Example : sample | string | |
| service_id required | Service Id Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string |
2.2.18 - FunctionConfig
| Name | Description | Schema | Default |
|---|---|---|---|
| max_scale required | Max Scale Example : 5 | integer | |
| memory required | Memory Example : 256 | integer | |
| min_scale required | Min Scale Example : 1 | integer | |
| timeout required | Timeout Example : 100 | integer |
2.2.19 - FunctionUrl
| Name | Description | Schema | Default |
|---|---|---|---|
| allow_ips optional | Allow Ips Example : | any of [array[string], null] | |
| auth_type optional | Auth Type Example : NONE | any of [string, null] | |
| public_endpoint_url optional | Public Endpoint Url Example : https://scf.33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/sample-function | any of [string, null] | |
| public_ip_acl_enabled optional | Public IP ACL Enabled Example : True | any of [boolean, null] | |
| url_enabled required | URL Enabled Example : True | boolean |
2.2.20 - FunctionUrlRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| allow_ips optional | Allow Ips Example : | any of [array[string], null] | |
| auth_type optional | Auth Type Example : NONE | any of [string, null] | |
| public_ip_acl_enabled required | Public IP ACL Enabled Example : True | boolean | |
| url_enabled required | URL Enabled Example : True | boolean |
2.2.21 - FunctionUrlV1Dot3
| Name | Description | Schema | Default |
|---|---|---|---|
| allow_ips optional | Allow Ips Example : | any of [array[string], null] | |
| auth_type optional | Auth Type Example : NONE | any of [string, null] | |
| public_endpoint_url optional | Public Endpoint Url Example : https://scf.33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/sample-function | any of [string, null] | |
| public_ip_acl_enabled optional | Public IP ACL Enabled Example : True | any of [boolean, null] | |
| state optional | Function URL State Example : CREATING | any of [string, null] | |
| url_enabled required | URL Enabled Example : True | boolean |
2.2.22 - FunctionVariable
| Name | Description | Schema | Default |
|---|---|---|---|
| key required | Key Example : sample | string | |
| value required | Value Example : sample | string |
2.2.23 - FunctionVariables
| Name | Description | Schema | Default |
|---|---|---|---|
| variables required | Environment Variables | array[FunctionVariable] |
2.2.24 - Log
| Name | Description | Schema | Default |
|---|---|---|---|
| log required | Log Example : [2025-05-12 11:04:12] START RequestId : 04680bac - ad76-4e0a-997e-e35b6275cb67 Version : $LATEST | string | |
| time required | Time Example : 2025-05-17 00:23:17 | string |
2.2.25 - LogShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | Count Example : 3 | integer | |
| logs required | Log | array[Log] |
2.2.26 - Metric
| Name | Description | Schema | Default |
|---|---|---|---|
| metric_data required | Metric Data Example : 1.0033444816053512 | object | |
| time required | Time Example : 16:37 | string |
2.2.27 - MetricShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| actual_pods required | Actual pods | array[Metric] | |
| fail_count required | Fail count | array[Metric] | |
| function_memory required | Function memory | array[Metric] | |
| request_count required | Request count | array[Metric] | |
| request_latency required | Request latency | array[Metric] | |
| success_count required | Success count | array[Metric] |
2.2.28 - PolicyDocument
| Name | Description | Schema | Default |
|---|---|---|---|
| Statement required | Statement Example : {'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'} | array[Statement] | |
| Version required | Version Example : 2024-07-01 | string |
2.2.29 - PrivateLinkEndpoint
| Name | Description | Schema | Default |
|---|---|---|---|
| endpoint required | Endpoint | Endpoint |
2.2.30 - PrivateLinkEndpointApproval
| Name | Description | Schema | Default |
|---|---|---|---|
| type required | Type Example : APPROVE | enum (APPROVE, REJECT) |
2.2.31 - PrivateLinkEndpointConnection
| Name | Description | Schema | Default |
|---|---|---|---|
| type required | Type Example : RECONNECT | enum (DISCONNECT, RECONNECT) |
2.2.32 - PrivateLinkEndpointCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| endpoint required | Endpoint | EndpointCreateRequest |
2.2.33 - PrivateLinkEndpointList
| Name | Description | Schema | Default |
|---|---|---|---|
| privatelink_endpoints required | Endpoints | any of [array[Endpoint], null] |
2.2.34 - PrivateLinkEndpointRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| type required | Type Example : CANCEL | enum (CANCEL, RE_REQUEST) |
2.2.35 - PrivateLinkService
| Name | Description | Schema | Default |
|---|---|---|---|
| private_url optional | Private Url Example : https://sample.scf.private.kr-west1.e.samsungsdscloud.com | any of [string, null] | |
| privatelink_service_enabled required | PrivateLink Service Enabled Example : True | boolean | |
| privatelink_service_id optional | PrivateLink Service ID Example : ba30549f550141ef9af6546543s | any of [string, null] | |
| privatelink_service_name optional | PrivateLink Service Name Example : 68216f8f56 | any of [string, null] | |
| requested_endpoints optional | Endpoint | any of [array[Endpoint], null] |
2.2.36 - PrivateLinkServicePutRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| privatelink_service_enabled required | PrivateLink Service Enabled Example : True | boolean |
2.2.37 - PrivateLinkServiceV1Dot3
| Name | Description | Schema | Default |
|---|---|---|---|
| private_url optional | Private Url Example : https://sample.scf.private.kr-west1.e.samsungsdscloud.com | any of [string, null] | |
| privatelink_service_auth_type optional | PrivateLink Service Auth Type Example : SCP_IAM | any of [string, null] | |
| privatelink_service_enabled required | PrivateLink Service Enabled Example : True | boolean | |
| privatelink_service_id optional | PrivateLink Service ID Example : ba30549f550141ef9af6546543s | any of [string, null] | |
| privatelink_service_name optional | PrivateLink Service Name Example : 68216f8f56 | any of [string, null] | |
| privatelink_service_state optional | State Example : Active | any of [string, null] | |
| requested_endpoints optional | Endpoint | any of [array[Endpoint], null] |
2.2.38 - ResourcePolicySetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| policy_document required | Policy Document Example : {'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'} | PolicyDocument |
2.2.39 - ResourcePolicyShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| policy_document optional | Policy Document Example : {'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'} | any of [PolicyDocument, null] |
2.2.40 - Runtime
| Name | Description | Schema | Default |
|---|---|---|---|
| base_image_seq required | Base image sequence Example : 3 | integer | |
| name required | Name Example : sample | string | |
| version required | Version Example : 1.0.0 | string |
2.2.41 - RuntimeListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | Count Example : 3 | integer | |
| runtimes required | Runtimes List | array[Runtime] |
2.2.42 - SampleCode
| Name | Description | Schema | Default |
|---|---|---|---|
| content required | Code content Example : sample | string | |
| default required | Default Example : False | boolean | |
| description required | Description Example : sample | string | |
| name required | Name Example : sample | string | |
| runtime required | Runtime Example : Node.js:20 | string | |
| seq required | Sequence Example : 3 | integer | |
| version required | Version Example : sample | string |
2.2.43 - SampleCodesListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | Count Example : 3 | integer | |
| sample_codes required | Sample Codes List | array[SampleCode] |
2.2.44 - Statement
| Name | Description | Schema | Default |
|---|---|---|---|
| Action optional | Action Example : ['iam:*'] | any of [array[string], null] | |
| Condition optional | Condition Example : {'StringEquals': {'scp:RequestedRegion': ['kr-west1']}} | any of [object[object[array[object]]], null] | |
| Effect required | Effect Example : Allow | enum (Allow, Deny) | |
| NotAction optional | Not Action Example : | any of [array[string], null] | |
| Principal optional | Principal Example : | any of [string, object[array[string]], null] | |
| Resource optional | Resource Example : ['*'] | array[string] | |
| Sid optional | Sid Example : Statement1 | string | statement1 |
2.2.45 - Tag
| Name | Description | Schema | Default |
|---|---|---|---|
| key required | Tag Key Example : | string | |
| value required | Tag Value Example : | any of [string, null] |
2.2.46 - Trigger
| Name | Description | Schema | Default |
|---|---|---|---|
| alias required | Alias Example : $LATEST | string | |
| schedule optional | Schedule Example : * * * * 0 | any of [string, null] | |
| timezone optional | Timezone Example : Asia/Tokyo | any of [string, null] | |
| trigger_id required | Trigger ID Example : 1 | integer | |
| trigger_name required | Trigger name Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | |
| trigger_sid required | Trigger target account ID Example : 617b3d0e90c24a5fa1f65a3824861354 | any of [string, null] | |
| trigger_target_account_id required | Trigger target account ID Example : 617b3d0e90c24a5fa1f65a3824861354 | any of [string, null] | |
| trigger_target_srn required | Trigger target SRN Example : srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe | any of [string, null] | |
| trigger_target_uuid required | Trigger target UUID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | any of [string, null] | |
| trigger_type required | Trigger type Example : apigateway | string |
2.2.47 - TriggerCreateResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| alias optional | Alias Example : $LATEST | any of [string, null] | |
| cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | |
| triggers required | Triggers | array[TriggerForList] |
2.2.48 - TriggerDeleteRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656Pattern : ^[0-9a-f]{32}$ | string | |
| trigger_type required | Trigger type Example : apigateway | string |
2.2.49 - TriggerForList
| Name | Description | Schema | Default |
|---|---|---|---|
| schedule optional | Schedule Example : * * * * 0 | any of [string, null] | |
| timezone optional | Timezone Example : Asia/Tokyo | any of [string, null] | |
| trigger_id optional | Trigger ID Example : 1 | any of [integer, null] | |
| trigger_name required | Trigger name Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | |
| trigger_target_account_id required | Trigger target account ID Example : 617b3d0e90c24a5fa1f65a3824861354 | any of [string, null] | |
| trigger_target_srn required | Trigger target SRN Example : srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe | any of [string, null] | |
| trigger_target_uuid required | Trigger target UUID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | any of [string, null] | |
| trigger_type required | Trigger type Example : apigateway | string |
2.2.50 - TriggersResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| alias required | Alias Example : $LATEST | string | |
| count required | Count Example : 20 | integer | |
| triggers required | Triggers | array[TriggerForList] |
2.2.51 - TriggerUpdateResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| alias optional | Alias Example : $LATEST | any of [string, null] | |
| cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | |
| triggers required | Triggers | array[TriggerForList] |
3 - Multi-node GPU Cluster
Overview
Provides an Application Programming Interface (API) that supports programmatic use of IaaS/PaaS products provided by SCP.
This guide provides a brief description of Multi-node GPU Cluster service and how to call API. The API is provided as a RESTful API, and it responds in JSON format.
Version
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Status | Not Before |
|---|---|---|
| 1.2 | CURRENT | - |
| 1.1 | DEPRECATED | 20260331 |
| 1.0 | DEPRECATED | 20251231 |
OpenAPI URL
https://multinodegpucluster.{region}.{environment}.samsungsdscloud.com
Environment and Region List
| environment | region |
|---|---|
| s | kr-west1 |
| s | kr-east1 |
| g | kr-south1 |
| g | kr-south2 |
| g | kr-south3 |
| e | kr-west1 |
| e | kr-east1 |
3.1 - APIs
3.1.1 - Assign GpuNode Public NAT IP
3.1.1.1 - 1.2
post /v1/gpu-nodes/{gpu_node_id}/public-nat-ip
Description
Assign public NAT IP to GPU Node.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | gpu_node_id required | GPU Node ID Example : 20c507a036c447cdb3b19468d8ea62ac | string | None |
| body | body required | GpuNodeAssignPublicNatIpRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | GpuNodeActionResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/gpu-nodes/{gpu_node_id}/public-nat-ip
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = multinodegpucluster 1.2"
Request body
{
"public_ip_address_id": ""
}
Example HTTP response
Response 202
{
"gpu_node_id": "20c507a036c447cdb3b19468d8ea62ac"
}
3.1.2 - Create GPU Nodes
3.1.2.1 - 1.2
post /v1/gpu-nodes
Description
Create GPU Nodes.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | GpuNodeCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | AsyncResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/gpu-nodes
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = multinodegpucluster 1.2"
Request body
{
"cluster_fabric_details": {
"cluster_fabric_id": "20c507a036c447cdb3b19468d8ea62ac",
"cluster_fabric_name": "cluster001",
"node_pool_id": "POOL001-krw1a"
},
"image_id": "IMAGE-7XFMaJpLsapKvskFMjCtmm",
"init_script": "init script",
"lock_enabled": true,
"os_user_id": "user001",
"os_user_password": "password",
"region_id": "kr-west1",
"server_details": [
{
"gpu_node_name": "gpu-node-001",
"ip_address": "192.168.0.1",
"nat_enabled": true,
"public_ip_address_id": "20c507a036c447cdb3b19468d8ea62ac",
"server_type_id": "f90e8ef54cc2451b825608e9f95f7bcb"
}
],
"subnet_id": "ab313c43291e4b678f4bacffe10768ae",
"tags": [
{
"key": "",
"value": ""
}
],
"vpc_id": "e58348b1bc9148e5af86500fd4ef99ca"
}
Example HTTP response
Response 202
{
"account_id": "f5c8e56a4d9b49a8bd89e14758a32d53",
"request_id": "req-002daa83-52d9-41e8-9b0f-d31d35610f65",
"resource_id": "20c507a036c447cdb3b19468d8ea62ac"
}
3.1.3 - Delete GPU Nodes
3.1.3.1 - 1.2
delete /v1/gpu-nodes
Description
Delete GPU Nodes.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | GpuNodeTerminateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | AsyncResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/gpu-nodes
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = multinodegpucluster 1.2"
Request body
{
"gpu_node_ids": [
"20c507a036c447cdb3b19468d8ea62ac"
]
}
Example HTTP response
Response 202
{
"account_id": "f5c8e56a4d9b49a8bd89e14758a32d53",
"request_id": "req-002daa83-52d9-41e8-9b0f-d31d35610f65",
"resource_id": "20c507a036c447cdb3b19468d8ea62ac"
}
3.1.4 - List Cluster Fabrics
3.1.4.1 - 1.2
get /v1/cluster-fabrics
Description
List Cluster Fabrics.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | cluster_fabric_name optional | Cluster Fabric 이름 Example : cluster001 | any of [string, null] | None |
| query | state optional | State Example : RUNNING | any of [string, null] | None |
| query | node_pool_id optional | Node Pool ID Example : POOL001-krw1a | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ClusterFabricListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cluster-fabrics
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = multinodegpucluster 1.2"
Example HTTP response
Response 200
{
"cluster_fabrics": [
{
"account_id": "f5c8e56a4d9b49a8bd89e14758a32d53",
"cluster_name": "cluster001",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "description",
"gpu_node_details": [
{
"gpu_node_id": "20c507a036c447cdb3b19468d8ea62ac",
"gpu_node_name": "gpu-node-001",
"policy_ip": "192.168.0.1",
"product_type_id": "f90e8ef54cc2451b825608e9f95f7bcb",
"server_type": "s1v8m32_metal",
"state": "RUNNING"
}
],
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"node_pool_id": "POOL001-krw1a",
"pirp_id": "20",
"product_id": "f90e8ef54cc2451b825608e9f95f7bcb",
"region_id": "kr-west1",
"server_type": "s1v8m32_metal",
"state": "RUNNING",
"used_server_count": 20
}
],
"count": 20
}
3.1.5 - List GPU Node Images
3.1.5.1 - 1.2
get /v1/gpu-nodes/images
Description
List GPU Node images.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | region_id required | Region ID Example : kr-west1 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | GpuNodeImageListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/gpu-nodes/images?region_id={region_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = multinodegpucluster 1.2"
Example HTTP response
Response 200
{
"images": [
{
"created_at": "2024-07-11 08:56:59",
"id": "IMAGE-7XFMaJpLsapKvskFMjCtmm",
"name": "RHEL 8.8 for BM",
"os_distro": "RHEL",
"priority": 20,
"scp_image_type": "STANDARD",
"scp_os_version": "8.7"
}
]
}
3.1.6 - List GPU Node Products
3.1.6.1 - 1.2
get /v1/gpu-nodes/products
Description
List GPU Node products.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | type optional | Product type Example : SCALE | any of [string, null] | None |
| query | image_id optional | Image ID Example : IMAGE-7XFMaJpLsapKvskFMjCtmm | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | GpuNodeProductListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/gpu-nodes/products
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = multinodegpucluster 1.2"
Example HTTP response
Response 200
{
"products": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "vCPU 16 │ Memory 128G │ Disk 480G",
"id": "SCALE",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "s2v16m128_metal",
"product_attrs": {
"compute_class_type_name": "GPU H100 Metal-2",
"compute_class_type_value": "g2_mteal",
"cpu_value": "64",
"disk_unit": "GB",
"disk_value": "480",
"gpu_model": "H100",
"memory_value": "128"
},
"state": "AVAILABLE",
"type": "SCALE"
}
]
}
3.1.7 - List GPU Nodes
3.1.7.1 - 1.2
get /v1/gpu-nodes
Description
List GPU Nodes.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | gpu_node_name optional | GPU Node Name Example : gpu-node-001 | any of [string, null] | None |
| query | state optional | GPU Node State Example : RUNNING | any of [string, null] | None |
| query | ip optional | Gpu Node ip Example : 192.168.0.1 | any of [string, null] | None |
| query | vpc_id optional | Gpu Node VPC ID Example : e58348b1bc9148e5af86500fd4ef99ca | any of [string, null] | None |
| query | cluster_fabric_name optional | Cluster Fabric 이름 Example : cluster001 | any of [string, null] | None |
| query | cluster_fabric_id optional | Cluster Fabric ID Example : 20c507a036c447cdb3b19468d8ea62ac | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | GpuNodeListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/gpu-nodes
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = multinodegpucluster 1.2"
Example HTTP response
Response 200
{
"count": 20,
"gpu_nodes": [
{
"account_id": "f5c8e56a4d9b49a8bd89e14758a32d53",
"cluster_fabric_id": "20c507a036c447cdb3b19468d8ea62ac",
"cluster_fabric_name": "cluster001",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"gpu_node_name": "gpu-node-001",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"image_id": "IMAGE-7XFMaJpLsapKvskFMjCtmm",
"image_version": "RHEL 8.7 for BM",
"init_script": "init script",
"lock_enabled": true,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"network_id": "ab313c43291e4b678f4bacffe10768ae",
"node_pool_id": "POOL001-krw1a",
"os_type": "WINDOWS",
"pfs_ip": [
"10.252.128.2",
"10.252.128.3"
],
"policy_ip": "192.168.0.1",
"policy_nat": "192.168.0.1",
"policy_use_nat": true,
"product_type_id": "f90e8ef54cc2451b825608e9f95f7bcb",
"region_id": "kr-west1",
"root_account": "rootaccount",
"server_type": "s1v8m32_metal",
"state": "RUNNING",
"time_zone": "Asia/Seoul",
"vpc_id": "e58348b1bc9148e5af86500fd4ef99ca"
}
]
}
3.1.8 - List Node Pools
3.1.8.1 - 1.2
get /v1/cluster-fabrics/node-pools
Description
List node pools.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | subnet_id optional | Subnet ID Example : ab313c43291e4b678f4bacffe10768ae | any of [string, null] | None |
| query | cluster_fabric_id optional | Cluster Fabric ID Example : 20c507a036c447cdb3b19468d8ea62ac | any of [string, null] | None |
| query | node_pool_id optional | Node Pool ID Example : POOL001-krw1a | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | NodePoolListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cluster-fabrics/node-pools
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = multinodegpucluster 1.2"
Example HTTP response
Response 200
{
"count": 20,
"node_pools": [
{
"cluster_fabric_details": [],
"node_pool_id": "POOL001-krw1a"
}
]
}
3.1.9 - Lock GPU Node
3.1.9.1 - 1.2
put /v1/gpu-nodes/{gpu_node_id}/lock
Description
Lock GPU Node.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | gpu_node_id required | GPU Node ID Example : 20c507a036c447cdb3b19468d8ea62ac | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | GpuNodeActionResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/gpu-nodes/{gpu_node_id}/lock
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = multinodegpucluster 1.2"
Example HTTP response
Response 200
{
"gpu_node_id": "20c507a036c447cdb3b19468d8ea62ac"
}
3.1.10 - Modify Cluster Fabric Members
3.1.10.1 - 1.2
post /v1/cluster-fabrics/modify-members
Description
Modify Cluster Fabric Members.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | ClusterFabricMemberModifyRequestBody |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | AsyncResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cluster-fabrics/modify-members
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = multinodegpucluster 1.2"
Request body
{
"after_cluster_fabric_id": "20c507a036c447cdb3b19468d8ea62ac",
"before_cluster_fabric_id": "20c507a036c447cdb3b19468d8ea62ac",
"gpu_node_id_list": [
"20c507a036c447cdb3b19468d8ea62ac"
]
}
Example HTTP response
Response 202
{
"account_id": "f5c8e56a4d9b49a8bd89e14758a32d53",
"request_id": "req-002daa83-52d9-41e8-9b0f-d31d35610f65",
"resource_id": "20c507a036c447cdb3b19468d8ea62ac"
}
3.1.11 - Release GPU Node Public NAT IP
3.1.11.1 - 1.2
delete /v1/gpu-nodes/{gpu_node_id}/public-nat-ip
Description
Release public NAT IP from GPU Node.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | gpu_node_id required | GPU Node ID Example : 20c507a036c447cdb3b19468d8ea62ac | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | GpuNodeActionResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/gpu-nodes/{gpu_node_id}/public-nat-ip
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = multinodegpucluster 1.2"
Example HTTP response
Response 202
{
"gpu_node_id": "20c507a036c447cdb3b19468d8ea62ac"
}
3.1.12 - Show Cluster Fabric
3.1.12.1 - 1.2
get /v1/cluster-fabrics/{cluster_fabric_id}
Description
Show Cluster Fabric.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cluster_fabric_id required | Cluster Fabric ID Example : 20c507a036c447cdb3b19468d8ea62ac | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ClusterFabricShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cluster-fabrics/{cluster_fabric_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = multinodegpucluster 1.2"
Example HTTP response
Response 200
{
"account_id": "f5c8e56a4d9b49a8bd89e14758a32d53",
"cluster_name": "cluster001",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "description",
"gpu_node_details": [
{
"gpu_node_id": "20c507a036c447cdb3b19468d8ea62ac",
"gpu_node_name": "gpu-node-001",
"policy_ip": "192.168.0.1",
"product_type_id": "f90e8ef54cc2451b825608e9f95f7bcb",
"server_type": "s1v8m32_metal",
"state": "RUNNING"
}
],
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"node_pool_id": "POOL001-krw1a",
"pirp_id": "20",
"product_id": "f90e8ef54cc2451b825608e9f95f7bcb",
"region_id": "kr-west1",
"server_type": "s1v8m32_metal",
"state": "RUNNING",
"used_server_count": 20
}
3.1.13 - Show GPU Node
3.1.13.1 - 1.2
get /v1/gpu-nodes/{gpu_node_id}
Description
Show GPU Node.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | gpu_node_id required | ID Example : 20c507a036c447cdb3b19468d8ea62ac | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | GpuNodeShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/gpu-nodes/{gpu_node_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = multinodegpucluster 1.2"
Example HTTP response
Response 200
{
"account_id": "f5c8e56a4d9b49a8bd89e14758a32d53",
"cluster_fabric_id": "20c507a036c447cdb3b19468d8ea62ac",
"cluster_fabric_name": "cluster001",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"gpu_node_name": "gpu-node-001",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"image_id": "IMAGE-7XFMaJpLsapKvskFMjCtmm",
"image_version": "RHEL 8.7 for BM",
"init_script": "init script",
"lock_enabled": true,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"network_id": "ab313c43291e4b678f4bacffe10768ae",
"node_pool_id": "POOL001-krw1a",
"os_type": "WINDOWS",
"pfs_ip": [
"10.252.128.2",
"10.252.128.3"
],
"policy_ip": "192.168.0.1",
"policy_nat": "192.168.0.1",
"policy_use_nat": true,
"product_type_id": "f90e8ef54cc2451b825608e9f95f7bcb",
"region_id": "kr-west1",
"root_account": "rootaccount",
"server_type": "s1v8m32_metal",
"state": "RUNNING",
"time_zone": "Asia/Seoul",
"vpc_id": "e58348b1bc9148e5af86500fd4ef99ca"
}
3.1.14 - Start GPU Nodes
3.1.14.1 - 1.2
post /v1/gpu-nodes/start
Description
Start GPU Nodes.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | GpuNodeOperationRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | AsyncResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/gpu-nodes/start
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = multinodegpucluster 1.2"
Request body
{
"gpu_node_ids": [
"20c507a036c447cdb3b19468d8ea62ac"
]
}
Example HTTP response
Response 202
{
"account_id": "f5c8e56a4d9b49a8bd89e14758a32d53",
"request_id": "req-002daa83-52d9-41e8-9b0f-d31d35610f65",
"resource_id": "20c507a036c447cdb3b19468d8ea62ac"
}
3.1.15 - Stop GPU Nodes
3.1.15.1 - 1.2
post /v1/gpu-nodes/stop
Description
Stop GPU Nodes.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | GpuNodeOperationRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | AsyncResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/gpu-nodes/stop
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = multinodegpucluster 1.2"
Request body
{
"gpu_node_ids": [
"20c507a036c447cdb3b19468d8ea62ac"
]
}
Example HTTP response
Response 202
{
"account_id": "f5c8e56a4d9b49a8bd89e14758a32d53",
"request_id": "req-002daa83-52d9-41e8-9b0f-d31d35610f65",
"resource_id": "20c507a036c447cdb3b19468d8ea62ac"
}
3.1.16 - Unlock GPU Node
3.1.16.1 - 1.2
put /v1/gpu-nodes/{gpu_node_id}/unlock
Description
Unlock GPU Node.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | gpu_node_id required | GPU Node ID Example : 20c507a036c447cdb3b19468d8ea62ac | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | GpuNodeActionResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/gpu-nodes/{gpu_node_id}/unlock
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = multinodegpucluster 1.2"
Example HTTP response
Response 200
{
"gpu_node_id": "20c507a036c447cdb3b19468d8ea62ac"
}
3.2 - Models
3.2.1 - AsyncResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : f5c8e56a4d9b49a8bd89e14758a32d53 | string | |
| request_id required | Request ID Example : req-002daa83-52d9-41e8-9b0f-d31d35610f65 | string | |
| resource_id required | Resource ID Example : 20c507a036c447cdb3b19468d8ea62ac | string |
3.2.2 - ClusterFabricDetailsRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| cluster_fabric_id required | Cluster Fabric ID Example : 20c507a036c447cdb3b19468d8ea62ac | any of [string, null] | |
| cluster_fabric_name required | Cluster Fabric 이름 Example : cluster001 | string | |
| node_pool_id required | Node Pool ID Example : POOL001-krw1a | string |
3.2.3 - ClusterFabricDetailsResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| cluster_fabric_id required | Cluster Fabric ID Example : 20c507a036c447cdb3b19468d8ea62ac | string | |
| cluster_fabric_name required | Cluster Fabric 이름 Example : cluster001 | string | |
| product_id required | Product ID Example : f90e8ef54cc2451b825608e9f95f7bcb | any of [string, null] |
3.2.4 - ClusterFabricListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| cluster_fabrics required | array[ClusterFabricShowResponse] | ||
| count required | count Example : 20 | any of [integer, null] |
3.2.5 - ClusterFabricMemberModifyRequestBody
| Name | Description | Schema | Default |
|---|---|---|---|
| after_cluster_fabric_id required | Cluster Fabric ID Example : 20c507a036c447cdb3b19468d8ea62ac | string | |
| before_cluster_fabric_id required | Cluster Fabric ID Example : 20c507a036c447cdb3b19468d8ea62ac | string | |
| gpu_node_id_list required | GPU Node ID List Example : ['20c507a036c447cdb3b19468d8ea62ac'] | array[string] |
3.2.6 - ClusterFabricShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : f5c8e56a4d9b49a8bd89e14758a32d53 | string | |
| cluster_name required | Cluster Fabric 이름 Example : cluster001 | string | |
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| description required | Description Example : description | string | |
| gpu_node_details optional | GPU Node 상세 | any of [array[GpuNodeDetailsResponse], null] | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| node_pool_id required | Node Pool ID Example : POOL001-krw1a | string | |
| pirp_id optional | pirpId Example : 20 | any of [string, null] | |
| product_id required | Product Type ID Example : f90e8ef54cc2451b825608e9f95f7bcb | string | |
| region_id required | Region ID Example : kr-west1 | string | |
| server_type optional | Server Type Example : s1v8m32_metal | any of [string, null] | |
| state required | State Example : RUNNING | string | |
| used_server_count optional | GPU Node Count Example : 20 | any of [integer, null] |
3.2.7 - GpuNodeActionResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| gpu_node_id required | GPU Node ID Example : 20c507a036c447cdb3b19468d8ea62ac | string |
3.2.8 - GpuNodeAssignPublicNatIpRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| public_ip_address_id required | Public NAT IP Address ID Example : | string |
3.2.9 - GpuNodeCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| cluster_fabric_details required | Cluster Fabric 상세 | ClusterFabricDetailsRequest | |
| image_id required | Image ID Example : IMAGE-7XFMaJpLsapKvskFMjCtmm | string | |
| init_script optional | Init Script Example : init script | any of [string, null] | |
| lock_enabled optional | 삭제 방지 여부 Example : True | boolean | |
| os_user_id required | OS 사용자 계정 Example : user001 | string | |
| os_user_password required | OS 사용자 패스워드 Example : password | string | |
| region_id required | Region ID Example : kr-west1 | string | |
| server_details required | 서버 상세 | array[GpuNodeDetailsRequest] | |
| subnet_id required | Subnet ID Example : ab313c43291e4b678f4bacffe10768ae | string | |
| tags required | Tags | any of [array[Tag], null] | |
| vpc_id required | VPC ID Example : e58348b1bc9148e5af86500fd4ef99ca | string |
3.2.10 - GpuNodeDetailsRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| gpu_node_name required | GPU Node Name Example : gpu-node-001 | string | |
| ip_address optional | Private IP Example : 192.168.0.1 | any of [string, null] | |
| nat_enabled required | NAT Enabled Example : True | boolean | |
| public_ip_address_id optional | NAT IP ID Example : 20c507a036c447cdb3b19468d8ea62ac | any of [string, null] | |
| server_type_id required | Server Type ID Example : f90e8ef54cc2451b825608e9f95f7bcb | string |
3.2.11 - GpuNodeDetailsResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| gpu_node_id required | ID Example : 20c507a036c447cdb3b19468d8ea62ac | string | |
| gpu_node_name required | GPU Node Name Example : gpu-node-001 | string | |
| policy_ip required | Policy IP Example : 192.168.0.1 | string | |
| product_type_id required | Product Type ID Example : f90e8ef54cc2451b825608e9f95f7bcb | string | |
| server_type optional | Server Type Example : s1v8m32_metal | any of [string, null] | |
| state required | State Example : RUNNING | string |
3.2.12 - GpuNodeImageListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| images required | array[GpuNodeImageShowResponse] |
3.2.13 - GpuNodeImageShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | Created at Example : 2024-07-11 08:56:59 | string | |
| id required | Image ID Example : IMAGE-7XFMaJpLsapKvskFMjCtmm | string | |
| name required | Name Example : RHEL 8.8 for BM | string | |
| os_distro required | OS Distro Example : RHEL | string | |
| priority required | GPU Node Image priority Example : 20 | string | |
| scp_image_type required | SCP image type Example : STANDARD | string | |
| scp_os_version required | SCP OS version Example : 8.7 | string |
3.2.14 - GpuNodeListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | GPU Node Count Example : 20 | any of [integer, null] | |
| gpu_nodes required | array[GpuNodeShowResponse] |
3.2.15 - GpuNodeOperationRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| gpu_node_ids required | GPU Node ID List Example : ['20c507a036c447cdb3b19468d8ea62ac'] | array[object] |
3.2.16 - GpuNodeProductAttr
| Name | Description | Schema | Default |
|---|---|---|---|
| compute_class_type_name required | Compute class type name Example : GPU H100 Metal-2 | string | |
| compute_class_type_value required | Compute class type unit Example : g2_mteal | string | |
| cpu_value required | CPU value Example : 64 | string | |
| disk_unit required | Disk unit Example : GB | string | |
| disk_value required | Disk value Example : 480 | string | |
| gpu_model required | GPU Model Example : H100 | string | |
| memory_value required | Memory value Example : 128 | string |
3.2.17 - GpuNodeProductListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| products required | Product List | array[GpuNodeProductShowResponse] |
3.2.18 - GpuNodeProductShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| description required | Description Example : vCPU 16 │ Memory 128G │ Disk 480G | string | |
| id required | ID Example : SCALE | string | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name required | Name Example : s2v16m128_metal | string | |
| product_attrs required | Product Attr | GpuNodeProductAttr | |
| state required | State Example : AVAILABLE | string | |
| type required | Type Example : SCALE | string |
3.2.19 - GpuNodeShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : f5c8e56a4d9b49a8bd89e14758a32d53 | string | |
| cluster_fabric_id optional | Cluster Fabric ID Example : 20c507a036c447cdb3b19468d8ea62ac | any of [string, null] | |
| cluster_fabric_name required | Cluster Fabric Name Example : cluster001 | string | |
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| gpu_node_name required | GPU Node Name Example : gpu-node-001 | string | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| image_id required | Image ID Example : IMAGE-7XFMaJpLsapKvskFMjCtmm | string | |
| image_version required | Image Version Example : RHEL 8.7 for BM | string | |
| init_script required | Init script Example : init script | string | |
| lock_enabled optional | lock_enabled Example : True | boolean | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| network_id required | Network ID Example : ab313c43291e4b678f4bacffe10768ae | string | |
| node_pool_id required | Node Pool ID Example : POOL001-krw1a | string | |
| os_type required | OS type Example : WINDOWS | string | |
| pfs_ip optional | PFS IP list Example : ['10.252.128.2', '10.252.128.3'] | any of [array[string], null] | |
| policy_ip required | Policy IP Example : 192.168.0.1 | string | |
| policy_nat optional | Policy NAT Example : 192.168.0.1 | any of [string, null] | |
| policy_use_nat optional | Policy use NAT Example : True | boolean | |
| product_type_id required | Product type ID Example : f90e8ef54cc2451b825608e9f95f7bcb | string | |
| region_id required | Region ID Example : kr-west1 | string | |
| root_account required | Root account Example : rootaccount | string | |
| server_type required | Server type Example : s1v8m32_metal | string | |
| state required | GPU Node State Example : RUNNING | string | |
| time_zone required | Time Zone Example : Asia/Seoul | string | |
| vpc_id required | VPC ID Example : e58348b1bc9148e5af86500fd4ef99ca | string |
3.2.20 - GpuNodeTerminateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| gpu_node_ids required | GPU Node ID List Example : ['20c507a036c447cdb3b19468d8ea62ac'] | array[object] |
3.2.21 - NodePoolListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | any of [integer, null] | |
| node_pools required | array[NodePoolShowResponse] |
3.2.22 - NodePoolShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| cluster_fabric_details optional | Cluster Fabric 상세 | array[ClusterFabricDetailsResponse] | |
| node_pool_id required | Node Pool ID Example : POOL001-krw1a | string |
3.2.23 - Tag
| Name | Description | Schema | Default |
|---|---|---|---|
| key optional | tag key Example : | any of [string, null] | |
| value optional | tag value Example : | any of [string, null] |
4 - Virtual Server
Overview
Provides an Application Programming Interface (API) that supports programmatic use of IaaS/PaaS products provided by SCP.
This guide provides a brief description of Virtual Server service and how to call API. The API is provided as a RESTful API, and it responds in JSON format.
Version
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Status | Not Before |
|---|---|---|
| 1.2 | CURRENT | - |
| 1.1 | DEPRECATED | 20260531 |
| 1.0 | DEPRECATED | 20251231 |
OpenAPI URL
https://virtualserver.{region}.{environment}.samsungsdscloud.com
Environment and Region List
| environment | region |
|---|---|
| s | kr-west1 |
| s | kr-east1 |
| g | kr-south1 |
| g | kr-south2 |
| g | kr-south3 |
| e | kr-west1 |
| e | kr-east1 |
4.1 - APIs
4.1.1 - Accept a volume transfer
4.1.1.1 - 1.2
post /v1/volume-transfer/{transfer_id}/accept
Description
Accept a volume transfer.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transfer_id required | Volume Transfer ID Example : 1ac231be-823b-4a4d-8ff0-aac503a7118a | string | None |
| body | body required | VolumeTransferAcceptRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | VolumeTransferAcceptResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/volume-transfer/{transfer_id}/accept
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"auth_key": "f5972fdb456897eb"
}
Example HTTP response
Response 202
{
"id": "1ac231be-823b-4a4d-8ff0-aac503a7118a",
"name": "volume01",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
4.1.1.2 - 1.1
post /v1/volume-transfer/{transfer_id}/accept
Description
Accept a volume transfer.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transfer_id required | Volume Transfer ID Example : 1ac231be-823b-4a4d-8ff0-aac503a7118a | string | None |
| body | body required | VolumeTransferAcceptRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | VolumeTransferAcceptResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/volume-transfer/{transfer_id}/accept
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"auth_key": "f5972fdb456897eb"
}
Example HTTP response
Response 202
{
"id": "1ac231be-823b-4a4d-8ff0-aac503a7118a",
"name": "volume01",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
4.1.1.3 - 1.0
post /v1/volume-transfer/{transfer_id}/accept
Description
Accept a volume transfer.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transfer_id required | Volume Transfer ID Example : 1ac231be-823b-4a4d-8ff0-aac503a7118a | string | None |
| body | body required | VolumeTransferAcceptRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | VolumeTransferAcceptResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/volume-transfer/{transfer_id}/accept
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"auth_key": "f5972fdb456897eb"
}
Example HTTP response
Response 202
{
"id": "1ac231be-823b-4a4d-8ff0-aac503a7118a",
"name": "volume01",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
4.1.2 - Attach Virtual Server Security Group
4.1.2.1 - 1.0
post /v1/servers/{server_id}/security-groups
Description
Attach Virtual Server Security Group.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| body | body required | ServerSecurityGroupActionRequestBody |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/security-groups
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"security_group_id": "c09c3f05-03d9-443f-b27a-40e0f973c75f"
}
Example HTTP response
Response 202
4.1.3 - Attach Volume to Virtual Server
4.1.3.1 - 1.2
post /v1/volumes/{volume_id}/servers
Description
Attach Volume to Virtual Server.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | volume_id required | Volume ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string | None |
| body | body required | VolumeServerAttachRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | VolumeServerAttachResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/volumes/{volume_id}/servers
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"delete_on_termination": false,
"server_id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
}
Example HTTP response
Response 202
{
"delete_on_termination": false,
"device": "/dev/vda",
"server_id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
4.1.3.2 - 1.1
post /v1/volumes/{volume_id}/servers
Description
Attach Volume to Virtual Server.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | volume_id required | Volume ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string | None |
| body | body required | VolumeServerAttachRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | VolumeServerAttachResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/volumes/{volume_id}/servers
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"delete_on_termination": false,
"server_id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
}
Example HTTP response
Response 202
{
"delete_on_termination": false,
"device": "/dev/vda",
"server_id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
4.1.3.3 - 1.0
post /v1/volumes/{volume_id}/servers
Description
Attach Volume to Virtual Server.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | volume_id required | Volume ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string | None |
| body | body required | VolumeServerAttachRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | VolumeServerAttachResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/volumes/{volume_id}/servers
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"delete_on_termination": false,
"server_id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
}
Example HTTP response
Response 202
{
"delete_on_termination": false,
"device": "/dev/vda",
"server_id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
4.1.4 - Create a snapshot
4.1.4.1 - 1.2
post /v1/snapshots
Description
Create a volume snapshot. This snapshot is a full copy of the volume. You can create a volume from the snapshot that was created.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | SnapshotCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | SnapshotDetailResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/snapshots
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"description": "description",
"force": true,
"metadata": "",
"name": "snapshot-1",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
Example HTTP response
Response 202
{
"created_at": "2025-07-22T09:00:00Z",
"description": "description",
"id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"metadata": "Metadata",
"name": "snapshot-1",
"size": 104,
"status": "available",
"updated_at": "2025-07-26T12:00:00Z",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
4.1.4.2 - 1.1
post /v1/snapshots
Description
Create a volume snapshot. This snapshot is a full copy of the volume. You can create a volume from the snapshot that was created.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | SnapshotCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | SnapshotDetailResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/snapshots
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"description": "description",
"force": true,
"metadata": "",
"name": "snapshot-1",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
Example HTTP response
Response 202
{
"created_at": "2025-07-22T09:00:00Z",
"description": "description",
"id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"metadata": "Metadata",
"name": "snapshot-1",
"size": 104,
"status": "available",
"updated_at": "2025-07-26T12:00:00Z",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
4.1.4.3 - 1.0
post /v1/snapshots
Description
Create a volume snapshot. This snapshot is a full copy of the volume. You can create a volume from the snapshot that was created.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | SnapshotCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | SnapshotDetailResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/snapshots
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"description": "description",
"force": true,
"metadata": "",
"name": "snapshot-1",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
Example HTTP response
Response 202
{
"created_at": "2025-07-22T09:00:00Z",
"description": "description",
"id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"metadata": "Metadata",
"name": "snapshot-1",
"size": 104,
"status": "available",
"updated_at": "2025-07-26T12:00:00Z",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
4.1.5 - Create a volume transfer
4.1.5.1 - 1.2
post /v1/volume-transfer
Description
Create a volume transfer.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | VolumeTransferRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | VolumeTransferCreateResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/volume-transfer
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"name": "volume01",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
Example HTTP response
Response 202
{
"auth_key": "f5972fdb456897eb",
"created_at": "",
"id": "1ac231be-823b-4a4d-8ff0-aac503a7118a",
"name": "volume01",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
4.1.5.2 - 1.1
post /v1/volume-transfer
Description
Create a volume transfer.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | VolumeTransferRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | VolumeTransferCreateResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/volume-transfer
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"name": "volume01",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
Example HTTP response
Response 202
{
"auth_key": "f5972fdb456897eb",
"created_at": "",
"id": "1ac231be-823b-4a4d-8ff0-aac503a7118a",
"name": "volume01",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
4.1.5.3 - 1.0
post /v1/volume-transfer
Description
Create a volume transfer.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | VolumeTransferRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | VolumeTransferCreateResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/volume-transfer
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"name": "volume01",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
Example HTTP response
Response 202
{
"auth_key": "f5972fdb456897eb",
"created_at": "",
"id": "1ac231be-823b-4a4d-8ff0-aac503a7118a",
"name": "volume01",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
4.1.6 - Create Auto-Scaling Group
4.1.6.1 - 1.2
post /v1/auto-scaling-groups
Description
Create Auto-Scaling Group.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | AutoScalingGroupCreateRequestV1Dot2 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | AutoScalingGroupShowResponseV1Dot2 |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/auto-scaling-groups
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"desired_server_count": 1,
"desired_server_count_editable": true,
"drain_enabled": true,
"drain_timeout": 300,
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"lb_server_groups": [],
"max_server_count": 2,
"min_server_count": 1,
"name": "auto-scaling-group-name",
"notifications": [],
"scaling_policies": [],
"security_group_ids": [
"c09c3f05-03d9-443f-b27a-40e0f973c75f"
],
"server_name_prefix": "server-name-prefix",
"state_check_delay_time": 300,
"subnet_ids": [
""
],
"tags": [
{
"key": "key",
"value": "value"
}
],
"use_lb_state_check": true
}
Example HTTP response
Response 201
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"desired_server_count": 1,
"desired_server_count_editable": true,
"drain_enabled": true,
"drain_timeout": 300,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"launch_configuration_name": "launch-configuration-name",
"lb_server_groups": [],
"max_server_count": 2,
"min_server_count": 1,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "auto-scaling-group-name",
"security_group_ids": [
"c09c3f05-03d9-443f-b27a-40e0f973c75f"
],
"server_name_prefix": "server-name-prefix",
"state": "IN_SERVICE",
"state_check_delay_time": 300,
"subnet_ids": [],
"total_server_count": 1,
"use_lb_state_check": true,
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
4.1.6.2 - 1.1
post /v1/auto-scaling-groups
Description
Create Auto-Scaling Group.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | AutoScalingGroupCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | AutoScalingGroupShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/auto-scaling-groups
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"desired_server_count": 1,
"desired_server_count_editable": true,
"drain_enabled": true,
"drain_timeout": 300,
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"lb_server_groups": [],
"max_server_count": 2,
"min_server_count": 1,
"name": "auto-scaling-group-name",
"notifications": [],
"scaling_policies": [],
"security_group_ids": [
"c09c3f05-03d9-443f-b27a-40e0f973c75f"
],
"server_name_prefix": "server-name-prefix",
"subnet_ids": [
""
],
"tags": [
{
"key": "key",
"value": "value"
}
]
}
Example HTTP response
Response 201
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"desired_server_count": 1,
"desired_server_count_editable": true,
"drain_enabled": true,
"drain_timeout": 300,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"launch_configuration_name": "launch-configuration-name",
"lb_server_groups": [],
"max_server_count": 2,
"min_server_count": 1,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "auto-scaling-group-name",
"security_group_ids": [
"c09c3f05-03d9-443f-b27a-40e0f973c75f"
],
"server_name_prefix": "server-name-prefix",
"state": "IN_SERVICE",
"subnet_ids": [],
"total_server_count": 1,
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
4.1.6.3 - 1.0
post /v1/auto-scaling-groups
Description
Create Auto-Scaling Group.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | AutoScalingGroupCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | AutoScalingGroupShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/auto-scaling-groups
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"desired_server_count": 1,
"desired_server_count_editable": true,
"drain_enabled": true,
"drain_timeout": 300,
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"lb_server_groups": [],
"max_server_count": 2,
"min_server_count": 1,
"name": "auto-scaling-group-name",
"notifications": [],
"scaling_policies": [],
"security_group_ids": [
"c09c3f05-03d9-443f-b27a-40e0f973c75f"
],
"server_name_prefix": "server-name-prefix",
"subnet_ids": [
""
],
"tags": [
{
"key": "key",
"value": "value"
}
]
}
Example HTTP response
Response 201
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"desired_server_count": 1,
"desired_server_count_editable": true,
"drain_enabled": true,
"drain_timeout": 300,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"launch_configuration_name": "launch-configuration-name",
"lb_server_groups": [],
"max_server_count": 2,
"min_server_count": 1,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "auto-scaling-group-name",
"security_group_ids": [
"c09c3f05-03d9-443f-b27a-40e0f973c75f"
],
"server_name_prefix": "server-name-prefix",
"state": "IN_SERVICE",
"subnet_ids": [],
"total_server_count": 1,
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
4.1.7 - Create Auto-Scaling Group Notification
4.1.7.1 - 1.2
post /v1/auto-scaling-groups/{auto_scaling_group_id}/notifications
Description
Create Auto-Scaling Group notification.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| body | body required | AutoScalingGroupNotificationCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | AutoScalingGroupNotificationListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/notifications
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"notification_events": [
"SCALE_OUT",
"SCALE_OUT_FAIL"
],
"user_ids": [
"570907805e5447be84b618450ef52o0t"
]
}
Example HTTP response
Response 201
{
"count": 20,
"notifications": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"notification_events": [
"SCALE_OUT",
"SCALE_OUT_FAIL"
],
"notification_state": "ACTIVE",
"user_email": "scpuser@samsung.com",
"user_id": "570907805e5447be84b618450ef52o0t",
"user_name": "scpuser"
}
]
}
4.1.7.2 - 1.1
post /v1/auto-scaling-groups/{auto_scaling_group_id}/notifications
Description
Create Auto-Scaling Group notification.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| body | body required | AutoScalingGroupNotificationCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | AutoScalingGroupNotificationListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/notifications
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"notification_events": [
"SCALE_OUT",
"SCALE_OUT_FAIL"
],
"user_ids": [
"570907805e5447be84b618450ef52o0t"
]
}
Example HTTP response
Response 201
{
"count": 20,
"notifications": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"notification_events": [
"SCALE_OUT",
"SCALE_OUT_FAIL"
],
"notification_state": "ACTIVE",
"user_email": "scpuser@samsung.com",
"user_id": "570907805e5447be84b618450ef52o0t",
"user_name": "scpuser"
}
]
}
4.1.7.3 - 1.0
post /v1/auto-scaling-groups/{auto_scaling_group_id}/notifications
Description
Create Auto-Scaling Group notification.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| body | body required | AutoScalingGroupNotificationCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | AutoScalingGroupNotificationListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/notifications
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"notification_events": [
"SCALE_OUT",
"SCALE_OUT_FAIL"
],
"user_ids": [
"570907805e5447be84b618450ef52o0t"
]
}
Example HTTP response
Response 201
{
"count": 20,
"notifications": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"notification_events": [
"SCALE_OUT",
"SCALE_OUT_FAIL"
],
"notification_state": "ACTIVE",
"user_email": "scpuser@samsung.com",
"user_id": "570907805e5447be84b618450ef52o0t",
"user_name": "scpuser"
}
]
}
4.1.8 - Create Auto-Scaling Group Policy
4.1.8.1 - 1.2
post /v1/auto-scaling-groups/{auto_scaling_group_id}/policies
Description
Create Auto-Scaling Group policy.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| body | body required | AutoScalingGroupPolicyCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | AutoScalingGroupPolicyShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/policies
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"comparison_operator": "ge",
"cooldown_seconds": 300,
"evaluation_minutes": 5,
"metric_method": "AVG",
"metric_type": "CPU",
"name": "policy-name",
"scale_method": "AMOUNT",
"scale_type": "SCALE_OUT",
"scale_value": 10,
"threshold": 60
}
Example HTTP response
Response 201
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"comparison_operator": "ge",
"cooldown_seconds": 300,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"evaluation_minutes": 5,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"metric_method": "AVG",
"metric_type": "CPU",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "policy-name",
"scale_method": "AMOUNT",
"scale_type": "SCALE_OUT",
"scale_value": 10,
"state": "ACTIVE",
"threshold": 60,
"threshold_unit": "%"
}
4.1.8.2 - 1.1
post /v1/auto-scaling-groups/{auto_scaling_group_id}/policies
Description
Create Auto-Scaling Group policy.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| body | body required | AutoScalingGroupPolicyCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | AutoScalingGroupPolicyShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/policies
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"comparison_operator": "ge",
"cooldown_seconds": 300,
"evaluation_minutes": 5,
"metric_method": "AVG",
"metric_type": "CPU",
"name": "policy-name",
"scale_method": "AMOUNT",
"scale_type": "SCALE_OUT",
"scale_value": 10,
"threshold": 60
}
Example HTTP response
Response 201
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"comparison_operator": "ge",
"cooldown_seconds": 300,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"evaluation_minutes": 5,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"metric_method": "AVG",
"metric_type": "CPU",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "policy-name",
"scale_method": "AMOUNT",
"scale_type": "SCALE_OUT",
"scale_value": 10,
"state": "ACTIVE",
"threshold": 60,
"threshold_unit": "%"
}
4.1.8.3 - 1.0
post /v1/auto-scaling-groups/{auto_scaling_group_id}/policies
Description
Create Auto-Scaling Group policy.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| body | body required | AutoScalingGroupPolicyCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | AutoScalingGroupPolicyShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/policies
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"comparison_operator": "ge",
"cooldown_seconds": 300,
"evaluation_minutes": 5,
"metric_method": "AVG",
"metric_type": "CPU",
"name": "policy-name",
"scale_method": "AMOUNT",
"scale_type": "SCALE_OUT",
"scale_value": 10,
"threshold": 60
}
Example HTTP response
Response 201
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"comparison_operator": "ge",
"cooldown_seconds": 300,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"evaluation_minutes": 5,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"metric_method": "AVG",
"metric_type": "CPU",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "policy-name",
"scale_method": "AMOUNT",
"scale_type": "SCALE_OUT",
"scale_value": 10,
"state": "ACTIVE",
"threshold": 60,
"threshold_unit": "%"
}
4.1.9 - Create Auto-Scaling Group Schedule
4.1.9.1 - 1.2
post /v1/auto-scaling-groups/{auto_scaling_group_id}/schedules
Description
Create Auto-Scaling Group schedule.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| body | body required | AutoScalingGroupScheduleCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | AutoScalingGroupScheduleShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/schedules
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"day_of_month": "-1,1",
"day_of_week": "SU,SA",
"description": "description",
"desired_server_count": 1,
"end_date": "2025-01-01",
"frequency": "WEEKLY",
"hour": 9,
"max_server_count": 2,
"min_server_count": 1,
"minute": 0,
"name": "schedulename",
"start_date": "2024-01-01",
"state": "ACTIVE",
"timezone": "Asia/Seoul"
}
Example HTTP response
Response 201
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"day_of_month": "-1,1",
"day_of_week": "SU,SA",
"description": "description",
"desired_server_count": 1,
"end_date": "2025-01-01",
"frequency": "WEEKLY",
"hour": 9,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"max_server_count": 2,
"min_server_count": 1,
"minute": 0,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "schedulename",
"start_date": "2024-01-01",
"state": "ACTIVE",
"timezone": "Asia/Seoul"
}
4.1.9.2 - 1.1
post /v1/auto-scaling-groups/{auto_scaling_group_id}/schedules
Description
Create Auto-Scaling Group schedule.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| body | body required | AutoScalingGroupScheduleCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | AutoScalingGroupScheduleShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/schedules
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"day_of_month": "-1,1",
"day_of_week": "SU,SA",
"description": "description",
"desired_server_count": 1,
"end_date": "2025-01-01",
"frequency": "WEEKLY",
"hour": 9,
"max_server_count": 2,
"min_server_count": 1,
"minute": 0,
"name": "schedulename",
"start_date": "2024-01-01",
"state": "ACTIVE",
"timezone": "Asia/Seoul"
}
Example HTTP response
Response 201
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"day_of_month": "-1,1",
"day_of_week": "SU,SA",
"description": "description",
"desired_server_count": 1,
"end_date": "2025-01-01",
"frequency": "WEEKLY",
"hour": 9,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"max_server_count": 2,
"min_server_count": 1,
"minute": 0,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "schedulename",
"start_date": "2024-01-01",
"state": "ACTIVE",
"timezone": "Asia/Seoul"
}
4.1.9.3 - 1.0
post /v1/auto-scaling-groups/{auto_scaling_group_id}/schedules
Description
Create Auto-Scaling Group schedule.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| body | body required | AutoScalingGroupScheduleCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | AutoScalingGroupScheduleShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/schedules
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"day_of_month": "-1,1",
"day_of_week": "SU,SA",
"description": "description",
"desired_server_count": 1,
"end_date": "2025-01-01",
"frequency": "WEEKLY",
"hour": 9,
"max_server_count": 2,
"min_server_count": 1,
"minute": 0,
"name": "schedulename",
"start_date": "2024-01-01",
"state": "ACTIVE",
"timezone": "Asia/Seoul"
}
Example HTTP response
Response 201
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"day_of_month": "-1,1",
"day_of_week": "SU,SA",
"description": "description",
"desired_server_count": 1,
"end_date": "2025-01-01",
"frequency": "WEEKLY",
"hour": 9,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"max_server_count": 2,
"min_server_count": 1,
"minute": 0,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "schedulename",
"start_date": "2024-01-01",
"state": "ACTIVE",
"timezone": "Asia/Seoul"
}
4.1.10 - Create Image
4.1.10.1 - 1.2
post /v1/images
Description
Create Image.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | ImageCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ImageShowResponseV1Dot2 |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/images
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"container_format": "bare",
"disk_format": "qcow2",
"min_disk": 100,
"min_ram": 0,
"name": "imagename",
"os_distro": "alma",
"protected": false,
"tags": [
{
"key": "key",
"value": "value"
}
],
"url": "https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2",
"visibility": "private"
}
Example HTTP response
Response 200
{
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"created_at": "2025-07-22T09:00:00Z",
"disk_format": "qcow2",
"file": "/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file",
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"min_disk": 100,
"min_ram": 0,
"name": "imagename",
"os_distro": "alma",
"os_hash_algo": "sha512",
"os_hash_value": "c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99",
"os_hidden": false,
"owner": "a8f10467abfc4b87b64614ab36eb9ae4",
"owner_account_name": "AccountName",
"owner_user_name": "user@samsung.com",
"protected": false,
"root_device_name": "/dev/vda",
"scp_gpu_driver": "535.183.06",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"scp_os_build_version": "20250101",
"scp_os_version": "8.8",
"size": 2429747200,
"status": "active",
"updated_at": "2025-07-26T12:00:00Z",
"url": "https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2",
"virtual_size": 17179869184,
"visibility": "private",
"volumes": "[{\"tag\": null, \"volume_id\": null, \"encryption_options\": null, \"encryption_secret_uuid\": null, \"encryption_format\": null, \"device_name\": \"/dev/vda\", \"disk_bus\": \"virtio\", \"volume_type\": null, \"encrypted\": null, \"image_id\": null, \"device_type\": \"disk\", \"source_type\": \"snapshot\", \"delete_on_termination\": false, \"volume_size\": 104, \"guest_format\": null, \"boot_index\": 0, \"destination_type\": \"volume\", \"snapshot_id\": \"abde9e38-2ed5-4ecd-b23c-b0120e30690e\", \"no_device\": null}]"
}
4.1.10.2 - 1.1
post /v1/images
Description
Create Image.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | ImageCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ImageShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/images
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"container_format": "bare",
"disk_format": "qcow2",
"min_disk": 100,
"min_ram": 0,
"name": "imagename",
"os_distro": "alma",
"protected": false,
"tags": [
{
"key": "key",
"value": "value"
}
],
"url": "https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2",
"visibility": "private"
}
Example HTTP response
Response 200
{
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"created_at": "2025-07-22T09:00:00Z",
"disk_format": "qcow2",
"file": "/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file",
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"min_disk": 100,
"min_ram": 0,
"name": "imagename",
"os_distro": "alma",
"os_hash_algo": "sha512",
"os_hash_value": "c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99",
"os_hidden": false,
"owner": "a8f10467abfc4b87b64614ab36eb9ae4",
"owner_account_name": "AccountName",
"owner_user_name": "user@samsung.com",
"protected": false,
"root_device_name": "/dev/vda",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"scp_os_build_version": "20250101",
"scp_os_version": "8.8",
"size": 2429747200,
"status": "active",
"updated_at": "2025-07-26T12:00:00Z",
"url": "https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2",
"virtual_size": 17179869184,
"visibility": "private",
"volumes": "[{\"tag\": null, \"volume_id\": null, \"encryption_options\": null, \"encryption_secret_uuid\": null, \"encryption_format\": null, \"device_name\": \"/dev/vda\", \"disk_bus\": \"virtio\", \"volume_type\": null, \"encrypted\": null, \"image_id\": null, \"device_type\": \"disk\", \"source_type\": \"snapshot\", \"delete_on_termination\": false, \"volume_size\": 104, \"guest_format\": null, \"boot_index\": 0, \"destination_type\": \"volume\", \"snapshot_id\": \"abde9e38-2ed5-4ecd-b23c-b0120e30690e\", \"no_device\": null}]"
}
4.1.10.3 - 1.0
post /v1/images
Description
Create Image.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | ImageCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ImageShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/images
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"container_format": "bare",
"disk_format": "qcow2",
"min_disk": 100,
"min_ram": 0,
"name": "imagename",
"os_distro": "alma",
"protected": false,
"tags": [
{
"key": "key",
"value": "value"
}
],
"url": "https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2",
"visibility": "private"
}
Example HTTP response
Response 200
{
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"created_at": "2025-07-22T09:00:00Z",
"disk_format": "qcow2",
"file": "/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file",
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"min_disk": 100,
"min_ram": 0,
"name": "imagename",
"os_distro": "alma",
"os_hash_algo": "sha512",
"os_hash_value": "c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99",
"os_hidden": false,
"owner": "a8f10467abfc4b87b64614ab36eb9ae4",
"owner_account_name": "AccountName",
"owner_user_name": "user@samsung.com",
"protected": false,
"root_device_name": "/dev/vda",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"scp_os_build_version": "20250101",
"scp_os_version": "8.8",
"size": 2429747200,
"status": "active",
"updated_at": "2025-07-26T12:00:00Z",
"url": "https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2",
"virtual_size": 17179869184,
"visibility": "private",
"volumes": "[{\"tag\": null, \"volume_id\": null, \"encryption_options\": null, \"encryption_secret_uuid\": null, \"encryption_format\": null, \"device_name\": \"/dev/vda\", \"disk_bus\": \"virtio\", \"volume_type\": null, \"encrypted\": null, \"image_id\": null, \"device_type\": \"disk\", \"source_type\": \"snapshot\", \"delete_on_termination\": false, \"volume_size\": 104, \"guest_format\": null, \"boot_index\": 0, \"destination_type\": \"volume\", \"snapshot_id\": \"abde9e38-2ed5-4ecd-b23c-b0120e30690e\", \"no_device\": null}]"
}
4.1.11 - Create Image member
4.1.11.1 - 1.2
post /v1/images/{image_id}/members
Description
Add account ID as a shared Image member.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | image_id required | Image ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | None |
| body | body required | ImageMemberCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ImageMemberShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/images/{image_id}/members
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"member_id": "a8f10467abfc4b87b64614ab36eb9ae4"
}
Example HTTP response
Response 200
{
"created_at": "2025-07-22T09:00:00Z",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"member_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"status": "pending",
"updated_at": "2025-07-26T12:00:00Z"
}
4.1.11.2 - 1.1
post /v1/images/{image_id}/members
Description
Add account ID as a shared Image member.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | image_id required | Image ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | None |
| body | body required | ImageMemberCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ImageMemberShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/images/{image_id}/members
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"member_id": "a8f10467abfc4b87b64614ab36eb9ae4"
}
Example HTTP response
Response 200
{
"created_at": "2025-07-22T09:00:00Z",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"member_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"status": "pending",
"updated_at": "2025-07-26T12:00:00Z"
}
4.1.11.3 - 1.0
post /v1/images/{image_id}/members
Description
Add account ID as a shared Image member.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | image_id required | Image ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | None |
| body | body required | ImageMemberCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ImageMemberShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/images/{image_id}/members
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"member_id": "a8f10467abfc4b87b64614ab36eb9ae4"
}
Example HTTP response
Response 200
{
"created_at": "2025-07-22T09:00:00Z",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"member_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"status": "pending",
"updated_at": "2025-07-26T12:00:00Z"
}
4.1.12 - Create Keypair
4.1.12.1 - 1.2
post /v1/keypairs
Description
Create a new Keypair or Import a Public Key.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | KeypairCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | KeypairCreateResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/keypairs
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"name": "keypairname",
"public_key": "ssh-rsa fakeKey Generated-by-SCP",
"tags": [
{
"key": "key",
"value": "value"
}
]
}
Example HTTP response
Response 201
{
"fingerprint": "7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd",
"name": "keypairname",
"private_key": "-----BEGIN RSA PRIVATE KEY-----\nfakeKey\n-----END RSA PRIVATE KEY-----",
"public_key": "ssh-rsa fakeKey Generated-by-SCP",
"type": "ssh"
}
4.1.12.2 - 1.1
post /v1/keypairs
Description
Create a new Keypair or Import a Public Key.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | KeypairCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | KeypairCreateResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/keypairs
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"name": "keypairname",
"public_key": "ssh-rsa fakeKey Generated-by-SCP",
"tags": [
{
"key": "key",
"value": "value"
}
]
}
Example HTTP response
Response 201
{
"fingerprint": "7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd",
"name": "keypairname",
"private_key": "-----BEGIN RSA PRIVATE KEY-----\nfakeKey\n-----END RSA PRIVATE KEY-----",
"public_key": "ssh-rsa fakeKey Generated-by-SCP",
"type": "ssh"
}
4.1.12.3 - 1.0
post /v1/keypairs
Description
Create a new Keypair or Import a Public Key.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | KeypairCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | KeypairCreateResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/keypairs
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"name": "keypairname",
"public_key": "ssh-rsa fakeKey Generated-by-SCP",
"tags": [
{
"key": "key",
"value": "value"
}
]
}
Example HTTP response
Response 201
{
"fingerprint": "7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd",
"name": "keypairname",
"private_key": "-----BEGIN RSA PRIVATE KEY-----\nfakeKey\n-----END RSA PRIVATE KEY-----",
"public_key": "ssh-rsa fakeKey Generated-by-SCP",
"type": "ssh"
}
4.1.13 - Create Launch Configuration
4.1.13.1 - 1.2
post /v1/launch-configurations
Description
Create Launch Configuration.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | LaunchConfigurationCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | LaunchConfigurationDetailShowResponseV1Dot2 |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/launch-configurations
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"keypair_name": "keypairname",
"name": "launch-configuration-name",
"server_type_id": "s1v1m2",
"tags": [
{
"key": "key",
"value": "value"
}
],
"user_data": "IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==",
"volumes": [
{
"boot_index": 0,
"size": 104,
"type": "SSD"
}
]
}
Example HTTP response
Response 201
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_count": 1,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"file_storage_ids": [
""
],
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"keypair_name": "keypairname",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "launch-configuration-name",
"public_key": "ssh-rsa fakeKey Generated-by-SCP",
"server_type_id": "s1v1m2",
"state": "ACTIVE",
"user_data": "IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==",
"volumes": [
{
"boot_index": 0,
"max_iops": 10000,
"max_throughput": 500,
"size": 104,
"type": "SSD"
}
]
}
4.1.13.2 - 1.1
post /v1/launch-configurations
Description
Create Launch Configuration.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | LaunchConfigurationCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | LaunchConfigurationDetailShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/launch-configurations
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"keypair_name": "keypairname",
"name": "launch-configuration-name",
"server_type_id": "s1v1m2",
"tags": [
{
"key": "key",
"value": "value"
}
],
"user_data": "IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==",
"volumes": [
{
"boot_index": 0,
"size": 104,
"type": "SSD"
}
]
}
Example HTTP response
Response 201
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_count": 1,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"keypair_name": "keypairname",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "launch-configuration-name",
"public_key": "ssh-rsa fakeKey Generated-by-SCP",
"server_type_id": "s1v1m2",
"state": "ACTIVE",
"user_data": "IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==",
"volumes": [
{
"boot_index": 0,
"size": 104,
"type": "SSD"
}
]
}
4.1.13.3 - 1.0
post /v1/launch-configurations
Description
Create Launch Configuration.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | LaunchConfigurationCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | LaunchConfigurationDetailShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/launch-configurations
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"keypair_name": "keypairname",
"name": "launch-configuration-name",
"server_type_id": "s1v1m2",
"tags": [
{
"key": "key",
"value": "value"
}
],
"user_data": "IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==",
"volumes": [
{
"boot_index": 0,
"size": 104,
"type": "SSD"
}
]
}
Example HTTP response
Response 201
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_count": 1,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"keypair_name": "keypairname",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "launch-configuration-name",
"public_key": "ssh-rsa fakeKey Generated-by-SCP",
"server_type_id": "s1v1m2",
"state": "ACTIVE",
"user_data": "IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==",
"volumes": [
{
"boot_index": 0,
"size": 104,
"type": "SSD"
}
]
}
4.1.14 - Create Server Group
4.1.14.1 - 1.2
post /v1/server-groups
Description
Create server group.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | ServerGroupCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | ServerGroup |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/server-groups
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"name": "server-group",
"policy": "anti-affinity",
"tags": [
{
"key": "key",
"value": "value"
}
]
}
Example HTTP response
Response 201
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"members": [
"2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
],
"name": "server-group",
"partition_size": 3,
"policy": "anti-affinity",
"user_id": "570907805e5447be84b618450ef52o0t"
}
4.1.14.2 - 1.1
post /v1/server-groups
Description
Create server group.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | ServerGroupCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | ServerGroup |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/server-groups
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"name": "server-group",
"policy": "anti-affinity",
"tags": [
{
"key": "key",
"value": "value"
}
]
}
Example HTTP response
Response 201
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"members": [
"2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
],
"name": "server-group",
"partition_size": 3,
"policy": "anti-affinity",
"user_id": "570907805e5447be84b618450ef52o0t"
}
4.1.14.3 - 1.0
post /v1/server-groups
Description
Create server group.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | ServerGroupCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | ServerGroup |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/server-groups
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"name": "server-group",
"policy": "anti-affinity",
"tags": [
{
"key": "key",
"value": "value"
}
]
}
Example HTTP response
Response 201
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"members": [
"2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
],
"name": "server-group",
"partition_size": 3,
"policy": "anti-affinity",
"user_id": "570907805e5447be84b618450ef52o0t"
}
4.1.15 - Create Server Interface
4.1.15.1 - 1.2
post /v1/servers/{server_id}/interfaces
Description
Create a new network port to the virtual server, or add an existing network port.
When creating a new network port, enter the subnet ID. IP can be set to auto-generate or user input fixed ips.
If you want to add an existing network port, enter the port ID.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| body | body required | ServerInterfaceCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | InterfaceResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"fixed_ips": [
{
"ip_address": "192.169.3.2"
}
],
"port_id": "91424c08-0b26-49fb-9808-ed042292ceef",
"subnet_id": "78b2ee3f074145c580ab6abac4821f97"
}
Example HTTP response
Response 200
{
"fixed_ips": [
{
"ip_address": "192.169.3.2"
}
],
"mac_addr": "fa:16:3e:c0:71:2b",
"port_id": "f2b02fc5-a5fd-4b5f-b1a9-987f4c0d66cc",
"port_state": "ACTIVE",
"private_static_nat": {
"external_ip_address": "182.197.61.81",
"id": "224b80106e6f41b38efe98ac9ddbf280",
"private_nat_ip_id": "1f0cb5390c40483592ddc5a282f53496",
"state": "ACTIVE"
},
"static_nat": {
"external_ip_address": "182.197.61.81",
"id": "224b80106e6f41b38efe98ac9ddbf280",
"publicip_id": "615fa9cd5cff486c9de679b3ce63e601",
"state": "ACTIVE"
},
"subnet_id": "183c6c30df0c4fcbb16422aa2d64aa21"
}
4.1.15.2 - 1.1
post /v1/servers/{server_id}/interfaces
Description
Create a new network port to the virtual server, or add an existing network port.
When creating a new network port, enter the subnet ID. IP can be set to auto-generate or user input fixed ips.
If you want to add an existing network port, enter the port ID.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| body | body required | ServerInterfaceCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | InterfaceResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"fixed_ips": [
{
"ip_address": "192.169.3.2"
}
],
"port_id": "91424c08-0b26-49fb-9808-ed042292ceef",
"subnet_id": "78b2ee3f074145c580ab6abac4821f97"
}
Example HTTP response
Response 200
{
"fixed_ips": [
{
"ip_address": "192.169.3.2"
}
],
"mac_addr": "fa:16:3e:c0:71:2b",
"port_id": "f2b02fc5-a5fd-4b5f-b1a9-987f4c0d66cc",
"port_state": "ACTIVE",
"private_static_nat": {
"external_ip_address": "182.197.61.81",
"id": "224b80106e6f41b38efe98ac9ddbf280",
"private_nat_ip_id": "1f0cb5390c40483592ddc5a282f53496",
"state": "ACTIVE"
},
"static_nat": {
"external_ip_address": "182.197.61.81",
"id": "224b80106e6f41b38efe98ac9ddbf280",
"publicip_id": "615fa9cd5cff486c9de679b3ce63e601",
"state": "ACTIVE"
},
"subnet_id": "183c6c30df0c4fcbb16422aa2d64aa21"
}
4.1.15.3 - 1.0
post /v1/servers/{server_id}/interfaces
Description
Create a new network port to the virtual server, or add an existing network port.
When creating a new network port, enter the subnet ID. IP can be set to auto-generate or user input fixed ips.
If you want to add an existing network port, enter the port ID.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| body | body required | ServerInterfaceCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | InterfaceResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"fixed_ips": [
{
"ip_address": "192.169.3.2"
}
],
"port_id": "91424c08-0b26-49fb-9808-ed042292ceef",
"subnet_id": "78b2ee3f074145c580ab6abac4821f97"
}
Example HTTP response
Response 200
{
"fixed_ips": [
{
"ip_address": "192.169.3.2"
}
],
"mac_addr": "fa:16:3e:c0:71:2b",
"port_id": "f2b02fc5-a5fd-4b5f-b1a9-987f4c0d66cc",
"port_state": "ACTIVE",
"private_static_nat": {
"external_ip_address": "182.197.61.81",
"id": "224b80106e6f41b38efe98ac9ddbf280",
"private_nat_ip_id": "1f0cb5390c40483592ddc5a282f53496",
"state": "ACTIVE"
},
"static_nat": {
"external_ip_address": "182.197.61.81",
"id": "224b80106e6f41b38efe98ac9ddbf280",
"publicip_id": "615fa9cd5cff486c9de679b3ce63e601",
"state": "ACTIVE"
},
"subnet_id": "183c6c30df0c4fcbb16422aa2d64aa21"
}
4.1.16 - Create Server Interface Nat
4.1.16.1 - 1.2
post /v1/servers/{server_id}/interfaces/{port_id}/static-nats
Description
Create Server Interface Public Nat.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| path | port_id required | Port ID Example : 91424c08-0b26-49fb-9808-ed042292ceef | string | None |
| body | body required | ServerStaticNatCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces/{port_id}/static-nats
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"publicip_id": "615fa9cd5cff486c9de679b3ce63e601"
}
Example HTTP response
Response 201
4.1.16.2 - 1.1
post /v1/servers/{server_id}/interfaces/{port_id}/static-nats
Description
Create Server Interface Public Nat.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| path | port_id required | Port ID Example : 91424c08-0b26-49fb-9808-ed042292ceef | string | None |
| body | body required | ServerStaticNatCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces/{port_id}/static-nats
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"publicip_id": "615fa9cd5cff486c9de679b3ce63e601"
}
Example HTTP response
Response 201
4.1.16.3 - 1.0
post /v1/servers/{server_id}/interfaces/{port_id}/static-nats
Description
Create Server Interface Public Nat.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| path | port_id required | Port ID Example : 91424c08-0b26-49fb-9808-ed042292ceef | string | None |
| body | body required | ServerStaticNatCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces/{port_id}/static-nats
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"publicip_id": "615fa9cd5cff486c9de679b3ce63e601"
}
Example HTTP response
Response 201
4.1.17 - Create Server Interface Private Nat
4.1.17.1 - 1.2
post /v1/servers/{server_id}/interfaces/{port_id}/private-static-nats
Description
Create Server Interface Private Nat.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| path | port_id required | Port ID Example : 91424c08-0b26-49fb-9808-ed042292ceef | string | None |
| body | body required | ServerPrivateStaticNatCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces/{port_id}/private-static-nats
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"private_nat_id": "3a6c1dc6b1b24e02a444d672c2798a1c",
"private_nat_ip_id": "1f0cb5390c40483592ddc5a282f53496"
}
Example HTTP response
Response 201
4.1.17.2 - 1.1
post /v1/servers/{server_id}/interfaces/{port_id}/private-static-nats
Description
Create Server Interface Private Nat.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| path | port_id required | Port ID Example : 91424c08-0b26-49fb-9808-ed042292ceef | string | None |
| body | body required | ServerPrivateStaticNatCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces/{port_id}/private-static-nats
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"private_nat_id": "3a6c1dc6b1b24e02a444d672c2798a1c",
"private_nat_ip_id": "1f0cb5390c40483592ddc5a282f53496"
}
Example HTTP response
Response 201
4.1.17.3 - 1.0
post /v1/servers/{server_id}/interfaces/{port_id}/private-static-nats
Description
Create Server Interface Private Nat.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| path | port_id required | Port ID Example : 91424c08-0b26-49fb-9808-ed042292ceef | string | None |
| body | body required | ServerPrivateStaticNatCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces/{port_id}/private-static-nats
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"private_nat_id": "3a6c1dc6b1b24e02a444d672c2798a1c",
"private_nat_ip_id": "1f0cb5390c40483592ddc5a282f53496"
}
Example HTTP response
Response 201
4.1.18 - Create Server Volume
4.1.18.1 - 1.2
post /v1/servers/{server_id}/volumes
Description
Attach volume that are created to server.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| body | body required | ServerVolumesCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServersVolumeResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/volumes
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"delete_on_termination": false,
"device": "/dev/vda",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
Example HTTP response
Response 200
{
"delete_on_termination": false,
"device": "/dev/vda",
"id": "3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c",
"server_id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
4.1.18.2 - 1.1
post /v1/servers/{server_id}/volumes
Description
Attach volume that are created to server.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| body | body required | ServerVolumesCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServersVolumeResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/volumes
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"delete_on_termination": false,
"device": "/dev/vda",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
Example HTTP response
Response 200
{
"delete_on_termination": false,
"device": "/dev/vda",
"id": "3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c",
"server_id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
4.1.18.3 - 1.0
post /v1/servers/{server_id}/volumes
Description
Attach volume that are created to server.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| body | body required | ServerVolumesCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServersVolumeResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/volumes
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"delete_on_termination": false,
"device": "/dev/vda",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
Example HTTP response
Response 200
{
"delete_on_termination": false,
"device": "/dev/vda",
"id": "3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c",
"server_id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
4.1.19 - Create Sharing Image
4.1.19.1 - 1.2
post /v1/images/{image_id}/share
Description
Create Sharing Image.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | image_id required | Image ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/images/{image_id}/share
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 202
4.1.19.2 - 1.1
post /v1/images/{image_id}/share
Description
Create Sharing Image.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | image_id required | Image ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/images/{image_id}/share
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 202
4.1.19.3 - 1.0
post /v1/images/{image_id}/share
Description
Create Sharing Image.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | image_id required | Image ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/images/{image_id}/share
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 202
4.1.20 - Create Virtual Server
4.1.20.1 - 1.2
post /v1/servers
Description
Create Virtual Server.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | ServerCreateRequestV1Dot2 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | ServerCreateResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"file_storage_ids": [
"96d258ea-dd5d-4cca-bb3a-b6909b7e2065",
"949bd9c7-2098-4284-9685-13268d193117"
],
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"keypair_name": "keypairname",
"lock": false,
"max_count": 2,
"metadata": "",
"name": "servername",
"networks": [
{
"fixed_ip": "192.169.3.2",
"port_id": "91424c08-0b26-49fb-9808-ed042292ceef",
"public_ip_id": "615fa9cd5cff486c9de679b3ce63e601",
"subnet_id": "78b2ee3f074145c580ab6abac4821f97"
}
],
"partition_number": 1,
"product_category": "compute",
"product_offering": "virtual_server",
"security_groups": [
"c09c3f05-03d9-443f-b27a-40e0f973c75f"
],
"server_group_id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"server_type_id": "s1v1m2",
"tags": [
{
"key": "key",
"value": "value"
}
],
"user_data": "IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==",
"volumes": [
{
"boot_index": 0,
"delete_on_termination": false,
"max_iops": 10000,
"max_throughput": 500,
"size": 104,
"source_type": "image",
"type": "SSD"
}
]
}
Example HTTP response
Response 202
{
"servers": [
{
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
}
]
}
4.1.20.2 - 1.1
post /v1/servers
Description
Create Virtual Server.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | ServerCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | ServerCreateResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"keypair_name": "keypairname",
"lock": false,
"max_count": 2,
"metadata": "",
"name": "servername",
"networks": [
{
"fixed_ip": "192.169.3.2",
"port_id": "91424c08-0b26-49fb-9808-ed042292ceef",
"public_ip_id": "615fa9cd5cff486c9de679b3ce63e601",
"subnet_id": "78b2ee3f074145c580ab6abac4821f97"
}
],
"partition_number": 1,
"product_category": "compute",
"product_offering": "virtual_server",
"security_groups": [
"c09c3f05-03d9-443f-b27a-40e0f973c75f"
],
"server_group_id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"server_type_id": "s1v1m2",
"tags": [
{
"key": "key",
"value": "value"
}
],
"user_data": "IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==",
"volumes": []
}
Example HTTP response
Response 202
{
"servers": [
{
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
}
]
}
4.1.20.3 - 1.0
post /v1/servers
Description
Create Virtual Server.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | ServerCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | ServerCreateResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"keypair_name": "keypairname",
"lock": false,
"max_count": 2,
"metadata": "",
"name": "servername",
"networks": [
{
"fixed_ip": "192.169.3.2",
"port_id": "91424c08-0b26-49fb-9808-ed042292ceef",
"public_ip_id": "615fa9cd5cff486c9de679b3ce63e601",
"subnet_id": "78b2ee3f074145c580ab6abac4821f97"
}
],
"partition_number": 1,
"product_category": "compute",
"product_offering": "virtual_server",
"security_groups": [
"c09c3f05-03d9-443f-b27a-40e0f973c75f"
],
"server_group_id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"server_type_id": "s1v1m2",
"tags": [
{
"key": "key",
"value": "value"
}
],
"user_data": "IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==",
"volumes": []
}
Example HTTP response
Response 202
{
"servers": [
{
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
}
]
}
4.1.21 - Create Virtual Server Custom Image
4.1.21.1 - 1.2
post /v1/servers/{server_id}/images
Description
Create Virtual Server Custom Image.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| body | body required | ServerCreateImageRequestBody |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | ServerCreateImageResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/images
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"image_name": "imagename"
}
Example HTTP response
Response 202
{
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b"
}
4.1.21.2 - 1.1
post /v1/servers/{server_id}/images
Description
Create Virtual Server Custom Image.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| body | body required | ServerCreateImageRequestBody |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | ServerCreateImageResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/images
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"image_name": "imagename"
}
Example HTTP response
Response 202
{
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b"
}
4.1.21.3 - 1.0
post /v1/servers/{server_id}/images
Description
Create Virtual Server Custom Image.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| body | body required | ServerCreateImageRequestBody |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | ServerCreateImageResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/images
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"image_name": "imagename"
}
Example HTTP response
Response 202
{
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b"
}
4.1.22 - Create Virtual Server Dump
4.1.22.1 - 1.2
post /v1/servers/{server_id}/dump
Description
Create Virtual Server Dump.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/dump
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 202
4.1.22.2 - 1.1
post /v1/servers/{server_id}/dump
Description
Create Virtual Server Dump.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/dump
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 202
4.1.22.3 - 1.0
post /v1/servers/{server_id}/dump
Description
Create Virtual Server Dump.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/dump
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 202
4.1.23 - Create Volume
4.1.23.1 - 1.2
post /v1/volumes
Description
Create a Volume.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | VolumeCreateRequestV1Dot2 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | VolumeShowResponseV1Dot2 |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/volumes
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"max_iops": 10000,
"max_throughput": 500,
"name": "volume01",
"size": 104,
"snapshot_id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"tags": [
{
"key": "key",
"value": "value"
}
],
"volume_type": "SSD"
}
Example HTTP response
Response 202
{
"bootable": false,
"created_at": "2026-04-14T15:06:27.997Z",
"encrypted": true,
"id": "3f500f00-ed80-4566-a057-e31760226f9a",
"max_iops": 10000,
"max_throughput": 500,
"modified_at": "2025-07-26T12:00:00Z",
"multiattach": false,
"name": "volume01",
"servers": [
{
"attached_at": "2026-04-14T15:06:27.997Z",
"device": "/dev/vda",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
}
],
"size": 104,
"snapshot_id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"state": "available",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_image_metadata": {
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"disk_format": "qcow2",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"min_disk": 100,
"min_ram": 0,
"os_distro": "alma",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"signature_verified": false,
"size": 2429747200
},
"volume_type": "SSD",
"volume_type_id": "c643ac35-3aec-43e6-b97a-3d6f666c5207"
}
4.1.23.2 - 1.1
post /v1/volumes
Description
Create a Volume.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | VolumeCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | VolumeShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/volumes
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"name": "volume01",
"size": 104,
"snapshot_id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"tags": [
{
"key": "key",
"value": "value"
}
],
"volume_type": "SSD"
}
Example HTTP response
Response 202
{
"bootable": false,
"created_at": "2026-04-14T15:06:25.499Z",
"encrypted": true,
"id": "3f500f00-ed80-4566-a057-e31760226f9a",
"modified_at": "2025-07-26T12:00:00Z",
"multiattach": false,
"name": "volume01",
"servers": [
{
"attached_at": "2026-04-14T15:06:25.499Z",
"device": "/dev/vda",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
}
],
"size": 104,
"snapshot_id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"state": "available",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_image_metadata": {
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"disk_format": "qcow2",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"min_disk": 100,
"min_ram": 0,
"os_distro": "alma",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"signature_verified": false,
"size": 2429747200
},
"volume_type": "SSD",
"volume_type_id": "c643ac35-3aec-43e6-b97a-3d6f666c5207"
}
4.1.23.3 - 1.0
post /v1/volumes
Description
Create a Volume.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | VolumeCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | VolumeShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/volumes
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"name": "volume01",
"size": 104,
"snapshot_id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"tags": [
{
"key": "key",
"value": "value"
}
],
"volume_type": "SSD"
}
Example HTTP response
Response 202
{
"bootable": false,
"created_at": "2026-04-14T15:06:23.000Z",
"encrypted": true,
"id": "3f500f00-ed80-4566-a057-e31760226f9a",
"modified_at": "2025-07-26T12:00:00Z",
"multiattach": false,
"name": "volume01",
"servers": [
{
"attached_at": "2026-04-14T15:06:23.000Z",
"device": "/dev/vda",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
}
],
"size": 104,
"snapshot_id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"state": "available",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_image_metadata": {
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"disk_format": "qcow2",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"min_disk": 100,
"min_ram": 0,
"os_distro": "alma",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"signature_verified": false,
"size": 2429747200
},
"volume_type": "SSD",
"volume_type_id": "c643ac35-3aec-43e6-b97a-3d6f666c5207"
}
4.1.24 - Delete a snapshot
4.1.24.1 - 1.2
delete /v1/snapshots/{snapshot_id}
Description
Delete a snapshot.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | snapshot_id required | Snapshot ID Example : cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/snapshots/{snapshot_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 202
4.1.24.2 - 1.1
delete /v1/snapshots/{snapshot_id}
Description
Delete a snapshot.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | snapshot_id required | Snapshot ID Example : cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/snapshots/{snapshot_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 202
4.1.24.3 - 1.0
delete /v1/snapshots/{snapshot_id}
Description
Delete a snapshot.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | snapshot_id required | Snapshot ID Example : cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/snapshots/{snapshot_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 202
4.1.25 - Delete a volume transfer
4.1.25.1 - 1.2
delete /v1/volume-transfer/{transfer_id}
Description
Delete a volume transfer.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transfer_id required | Volume Transfer ID Example : 1ac231be-823b-4a4d-8ff0-aac503a7118a | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/volume-transfer/{transfer_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 202
4.1.25.2 - 1.1
delete /v1/volume-transfer/{transfer_id}
Description
Delete a volume transfer.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transfer_id required | Volume Transfer ID Example : 1ac231be-823b-4a4d-8ff0-aac503a7118a | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/volume-transfer/{transfer_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 202
4.1.25.3 - 1.0
delete /v1/volume-transfer/{transfer_id}
Description
Delete a volume transfer.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transfer_id required | Volume Transfer ID Example : 1ac231be-823b-4a4d-8ff0-aac503a7118a | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/volume-transfer/{transfer_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 202
4.1.26 - Delete Auto-Scaling Group
4.1.26.1 - 1.2
delete /v1/auto-scaling-groups/{auto_scaling_group_id}
Description
Delete Auto-Scaling Group.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 204
4.1.26.2 - 1.1
delete /v1/auto-scaling-groups/{auto_scaling_group_id}
Description
Delete Auto-Scaling Group.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 204
4.1.26.3 - 1.0
delete /v1/auto-scaling-groups/{auto_scaling_group_id}
Description
Delete Auto-Scaling Group.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 204
4.1.27 - Delete Auto-Scaling Group Notification
4.1.27.1 - 1.2
delete /v1/auto-scaling-groups/{auto_scaling_group_id}/notifications/{notification_id}
Description
Delete Auto-Scaling Group notification.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| path | notification_id required | Auto-Scaling Group notification ID Example : fa7fd191410744cd810a290c0b4d22b9 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/notifications/{notification_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 204
4.1.27.2 - 1.1
delete /v1/auto-scaling-groups/{auto_scaling_group_id}/notifications/{notification_id}
Description
Delete Auto-Scaling Group notification.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| path | notification_id required | Auto-Scaling Group notification ID Example : fa7fd191410744cd810a290c0b4d22b9 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/notifications/{notification_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 204
4.1.27.3 - 1.0
delete /v1/auto-scaling-groups/{auto_scaling_group_id}/notifications/{notification_id}
Description
Delete Auto-Scaling Group notification.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| path | notification_id required | Auto-Scaling Group notification ID Example : fa7fd191410744cd810a290c0b4d22b9 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/notifications/{notification_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 204
4.1.28 - Delete Auto-Scaling Group Policy
4.1.28.1 - 1.2
delete /v1/auto-scaling-groups/{auto_scaling_group_id}/policies/{policy_id}
Description
Delete Auto-Scaling Group policy.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| path | policy_id required | Policy ID Example : 0761d76085f54363bab07909baf69841 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/policies/{policy_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 204
4.1.28.2 - 1.1
delete /v1/auto-scaling-groups/{auto_scaling_group_id}/policies/{policy_id}
Description
Delete Auto-Scaling Group policy.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| path | policy_id required | Policy ID Example : 0761d76085f54363bab07909baf69841 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/policies/{policy_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 204
4.1.28.3 - 1.0
delete /v1/auto-scaling-groups/{auto_scaling_group_id}/policies/{policy_id}
Description
Delete Auto-Scaling Group policy.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| path | policy_id required | Policy ID Example : 0761d76085f54363bab07909baf69841 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/policies/{policy_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 204
4.1.29 - Delete Auto-Scaling Group Schedule
4.1.29.1 - 1.2
delete /v1/auto-scaling-groups/{auto_scaling_group_id}/schedules/{schedule_id}
Description
Delete Auto-Scaling Group schedule.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| path | schedule_id required | Schedule ID Example : 43d4841abd404220af5f0904037aba71 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/schedules/{schedule_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 204
4.1.29.2 - 1.1
delete /v1/auto-scaling-groups/{auto_scaling_group_id}/schedules/{schedule_id}
Description
Delete Auto-Scaling Group schedule.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| path | schedule_id required | Schedule ID Example : 43d4841abd404220af5f0904037aba71 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/schedules/{schedule_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 204
4.1.29.3 - 1.0
delete /v1/auto-scaling-groups/{auto_scaling_group_id}/schedules/{schedule_id}
Description
Delete Auto-Scaling Group schedule.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| path | schedule_id required | Schedule ID Example : 43d4841abd404220af5f0904037aba71 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/schedules/{schedule_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 204
4.1.30 - Delete Image
4.1.30.1 - 1.2
delete /v1/images/{image_id}
Description
Delete Image.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | image_id required | Image ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/images/{image_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 204
4.1.30.2 - 1.1
delete /v1/images/{image_id}
Description
Delete Image.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | image_id required | Image ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/images/{image_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 204
4.1.30.3 - 1.0
delete /v1/images/{image_id}
Description
Delete Image.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | image_id required | Image ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/images/{image_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 204
4.1.31 - Delete Image member
4.1.31.1 - 1.2
delete /v1/images/{image_id}/members/{member_id}
Description
Delete Image member.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | image_id required | Image ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | None |
| path | member_id required | Shared Image member ID Example : a8f10467abfc4b87b64614ab36eb9ae4 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/images/{image_id}/members/{member_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 204
4.1.31.2 - 1.1
delete /v1/images/{image_id}/members/{member_id}
Description
Delete Image member.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | image_id required | Image ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | None |
| path | member_id required | Shared Image member ID Example : a8f10467abfc4b87b64614ab36eb9ae4 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/images/{image_id}/members/{member_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 204
4.1.31.3 - 1.0
delete /v1/images/{image_id}/members/{member_id}
Description
Delete Image member.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | image_id required | Image ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | None |
| path | member_id required | Shared Image member ID Example : a8f10467abfc4b87b64614ab36eb9ae4 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/images/{image_id}/members/{member_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 204
4.1.32 - Delete Keypair
4.1.32.1 - 1.2
delete /v1/keypairs/{keypair_name}
Description
Delete keypair.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | keypair_name required | Keypair name Example : keypairname | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/keypairs/{keypair_name}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 204
4.1.32.2 - 1.1
delete /v1/keypairs/{keypair_name}
Description
Delete keypair.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | keypair_name required | Keypair name Example : keypairname | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/keypairs/{keypair_name}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 204
4.1.32.3 - 1.0
delete /v1/keypairs/{keypair_name}
Description
Delete keypair.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | keypair_name required | Keypair name Example : keypairname | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/keypairs/{keypair_name}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 204
4.1.33 - Delete Launch Configuration
4.1.33.1 - 1.2
delete /v1/launch-configurations/{launch_configuration_id}
Description
Delete Launch Configuration.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | launch_configuration_id required | Launch Configuration ID Example : b5aea5a675fc4f6b9e0fcd1288354c5f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/launch-configurations/{launch_configuration_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 204
4.1.33.2 - 1.1
delete /v1/launch-configurations/{launch_configuration_id}
Description
Delete Launch Configuration.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | launch_configuration_id required | Launch Configuration ID Example : b5aea5a675fc4f6b9e0fcd1288354c5f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/launch-configurations/{launch_configuration_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 204
4.1.33.3 - 1.0
delete /v1/launch-configurations/{launch_configuration_id}
Description
Delete Launch Configuration.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | launch_configuration_id required | Launch Configuration ID Example : b5aea5a675fc4f6b9e0fcd1288354c5f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/launch-configurations/{launch_configuration_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 204
4.1.34 - Delete Server Group
4.1.34.1 - 1.2
delete /v1/server-groups/{server_group_id}
Description
Delete server group
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_group_id required | Server Group ID Example : 616fb98f-46ca-475e-917e-2563e5a8cd19 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/server-groups/{server_group_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
4.1.34.2 - 1.1
delete /v1/server-groups/{server_group_id}
Description
Delete server group
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_group_id required | Server Group ID Example : 616fb98f-46ca-475e-917e-2563e5a8cd19 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/server-groups/{server_group_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
4.1.34.3 - 1.0
delete /v1/server-groups/{server_group_id}
Description
Delete server group
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_group_id required | Server Group ID Example : 616fb98f-46ca-475e-917e-2563e5a8cd19 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/server-groups/{server_group_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
4.1.35 - Delete Server Interface
4.1.35.1 - 1.2
delete /v1/servers/{server_id}/interfaces/{port_id}
Description
Delete Server Interface.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| path | port_id required | Port ID Example : 91424c08-0b26-49fb-9808-ed042292ceef | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces/{port_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
4.1.35.2 - 1.1
delete /v1/servers/{server_id}/interfaces/{port_id}
Description
Delete Server Interface.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| path | port_id required | Port ID Example : 91424c08-0b26-49fb-9808-ed042292ceef | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces/{port_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
4.1.35.3 - 1.0
delete /v1/servers/{server_id}/interfaces/{port_id}
Description
Delete Server Interface.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| path | port_id required | Port ID Example : 91424c08-0b26-49fb-9808-ed042292ceef | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces/{port_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
4.1.36 - Delete Server Interface Nat
4.1.36.1 - 1.2
delete /v1/servers/{server_id}/interfaces/{port_id}/static-nats/{nat_id}
Description
Delete Server Interface Public Nat.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| path | port_id required | Port ID Example : 91424c08-0b26-49fb-9808-ed042292ceef | string | None |
| path | nat_id required | NAT ID Example : 224b80106e6f41b38efe98ac9ddbf280 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces/{port_id}/static-nats/{nat_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 202
4.1.36.2 - 1.1
delete /v1/servers/{server_id}/interfaces/{port_id}/static-nats/{nat_id}
Description
Delete Server Interface Public Nat.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| path | port_id required | Port ID Example : 91424c08-0b26-49fb-9808-ed042292ceef | string | None |
| path | nat_id required | NAT ID Example : 224b80106e6f41b38efe98ac9ddbf280 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces/{port_id}/static-nats/{nat_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 202
4.1.36.3 - 1.0
delete /v1/servers/{server_id}/interfaces/{port_id}/static-nats/{nat_id}
Description
Delete Server Interface Public Nat.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| path | port_id required | Port ID Example : 91424c08-0b26-49fb-9808-ed042292ceef | string | None |
| path | nat_id required | NAT ID Example : 224b80106e6f41b38efe98ac9ddbf280 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces/{port_id}/static-nats/{nat_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 202
4.1.37 - Delete Server Interface Private Nat
4.1.37.1 - 1.2
delete /v1/servers/{server_id}/interfaces/{port_id}/private-static-nats/{nat_id}
Description
Delete Server Interface Private Nat.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| path | port_id required | Port ID Example : 91424c08-0b26-49fb-9808-ed042292ceef | string | None |
| path | nat_id required | NAT ID Example : 224b80106e6f41b38efe98ac9ddbf280 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces/{port_id}/private-static-nats/{nat_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 202
4.1.37.2 - 1.1
delete /v1/servers/{server_id}/interfaces/{port_id}/private-static-nats/{nat_id}
Description
Delete Server Interface Private Nat.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| path | port_id required | Port ID Example : 91424c08-0b26-49fb-9808-ed042292ceef | string | None |
| path | nat_id required | NAT ID Example : 224b80106e6f41b38efe98ac9ddbf280 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces/{port_id}/private-static-nats/{nat_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 202
4.1.37.3 - 1.0
delete /v1/servers/{server_id}/interfaces/{port_id}/private-static-nats/{nat_id}
Description
Delete Server Interface Private Nat.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| path | port_id required | Port ID Example : 91424c08-0b26-49fb-9808-ed042292ceef | string | None |
| path | nat_id required | NAT ID Example : 224b80106e6f41b38efe98ac9ddbf280 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces/{port_id}/private-static-nats/{nat_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 202
4.1.38 - Delete Server Volume
4.1.38.1 - 1.2
delete /v1/servers/{server_id}/volumes/{volume_id}
Description
Delete Server Volume.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| path | volume_id required | Volume ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/volumes/{volume_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 202
4.1.38.2 - 1.1
delete /v1/servers/{server_id}/volumes/{volume_id}
Description
Delete Server Volume.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| path | volume_id required | Volume ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/volumes/{volume_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 202
4.1.38.3 - 1.0
delete /v1/servers/{server_id}/volumes/{volume_id}
Description
Delete Server Volume.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| path | volume_id required | Volume ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/volumes/{volume_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 202
4.1.39 - Delete Virtual Server
4.1.39.1 - 1.2
delete /v1/servers/{server_id}
Description
Delete Virtual Server.
Once deleted, the server cannot be recovered and will not be retrieved from the server list.
The termination of the connected storage depends on the delete on termination setting, so if necessary, from Block Storage terminate it.
In case of deletion failure.
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 202
4.1.39.2 - 1.1
delete /v1/servers/{server_id}
Description
Delete Virtual Server.
Once deleted, the server cannot be recovered and will not be retrieved from the server list.
The termination of the connected storage depends on the delete on termination setting, so if necessary, from Block Storage terminate it.
In case of deletion failure.
File Storage connected
LB Server Group connected(Except VMs generated by Auto-Scaling Group)
Lock set
Backup connected
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 202
4.1.39.3 - 1.0
delete /v1/servers/{server_id}
Description
Delete Virtual Server.
Once deleted, the server cannot be recovered and will not be retrieved from the server list.
The termination of the connected storage depends on the delete on termination setting, so if necessary, from Block Storage terminate it.
In case of deletion failure.
File Storage connected
LB Server Group connected(Except VMs generated by Auto-Scaling Group)
Lock set
Backup connected
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 202
4.1.40 - Delete Volume
4.1.40.1 - 1.2
delete /v1/volumes/{volume_id}
Description
Delete Volume.
- The termination of the connected storage depends on the delete on termination setting, so if necessary, from Block Storage terminate it.
If a volume cannot be deleted.
Connected to server
OS Default volume
Connection with custom Image of Virtual Server
If volume is in state other than available, error, error extending, error restoring, or error managing
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | volume_id required | Volume ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string | None |
| query | cascade optional | Whether to delete snapshots together Example : True | any of [boolean, null] | True |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/volumes/{volume_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 202
4.1.40.2 - 1.1
delete /v1/volumes/{volume_id}
Description
Delete Volume.
- The termination of the connected storage depends on the delete on termination setting, so if necessary, from Block Storage terminate it.
If a volume cannot be deleted.
Connected to server
OS Default volume
Connection with custom Image of Virtual Server
If volume is in state other than available, error, error extending, error restoring, or error managing
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | volume_id required | Volume ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string | None |
| query | cascade optional | Whether to delete snapshots together Example : True | any of [boolean, null] | True |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/volumes/{volume_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 202
4.1.40.3 - 1.0
delete /v1/volumes/{volume_id}
Description
Delete Volume.
- The termination of the connected storage depends on the delete on termination setting, so if necessary, from Block Storage terminate it.
If a volume cannot be deleted.
Connected to server
OS Default volume
Connection with custom Image of Virtual Server
If volume is in state other than available, error, error extending, error restoring, or error managing
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | volume_id required | Volume ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string | None |
| query | cascade optional | Whether to delete snapshots together Example : True | any of [boolean, null] | True |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/volumes/{volume_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 202
4.1.41 - Detach Virtual Server Security Group
4.1.41.1 - 1.0
delete /v1/servers/{server_id}/security-groups/{security_group_id}
Description
Detach the Security Group from a server.
- If a server has one or more networks attached, and the Security Group you want to detach is currently applied to all of those networks, then the Security Group will be removed from every network associated with a server.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| path | security_group_id required | Security Group ID Example : c09c3f05-03d9-443f-b27a-40e0f973c75f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/security-groups/{security_group_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 202
4.1.42 - Detach Volume from Virtual Server
4.1.42.1 - 1.2
delete /v1/volumes/{volume_id}/servers/{server_id}
Description
Detach the Volume from a server.
For the OS’s default volume, you cannot modify the attached server or cancel the service.
On the server, be sure to perform the disconnection steps (unmount, set the disk offline) before detaching the attached server. If a server is detached without these OS‑level actions, it may enter an error state (Hang).
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | volume_id required | Volume ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string | None |
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/volumes/{volume_id}/servers/{server_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 202
4.1.42.2 - 1.1
delete /v1/volumes/{volume_id}/servers/{server_id}
Description
Detach the Volume from a server.
For the OS’s default volume, you cannot modify the attached server or cancel the service.
On the server, be sure to perform the disconnection steps (unmount, set the disk offline) before detaching the attached server. If a server is detached without these OS‑level actions, it may enter an error state (Hang).
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | volume_id required | Volume ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string | None |
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/volumes/{volume_id}/servers/{server_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 202
4.1.42.3 - 1.0
delete /v1/volumes/{volume_id}/servers/{server_id}
Description
Detach the Volume from a server.
For the OS’s default volume, you cannot modify the attached server or cancel the service.
On the server, be sure to perform the disconnection steps (unmount, set the disk offline) before detaching the attached server. If a server is detached without these OS‑level actions, it may enter an error state (Hang).
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | volume_id required | Volume ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string | None |
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/volumes/{volume_id}/servers/{server_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 202
4.1.43 - Extend Volume
4.1.43.1 - 1.2
put /v1/volumes/{volume_id}/size
Description
Increase the volume capacity.
Volume capacity can only be increased, reduction is not supported.
When increasing capacity, recovery is possible only by creating new volume from a previously taken snapshot (i.e., the snapshot can be used solely for the new‑volume creation method).
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | volume_id required | Volume ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string | None |
| body | body required | VolumeExtendRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | VolumeShowResponseV1Dot2 |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/volumes/{volume_id}/size
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"size": 104
}
Example HTTP response
Response 202
{
"bootable": false,
"created_at": "2026-04-14T15:06:28.153Z",
"encrypted": true,
"id": "3f500f00-ed80-4566-a057-e31760226f9a",
"max_iops": 10000,
"max_throughput": 500,
"modified_at": "2025-07-26T12:00:00Z",
"multiattach": false,
"name": "volume01",
"servers": [
{
"attached_at": "2026-04-14T15:06:28.153Z",
"device": "/dev/vda",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
}
],
"size": 104,
"snapshot_id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"state": "available",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_image_metadata": {
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"disk_format": "qcow2",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"min_disk": 100,
"min_ram": 0,
"os_distro": "alma",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"signature_verified": false,
"size": 2429747200
},
"volume_type": "SSD",
"volume_type_id": "c643ac35-3aec-43e6-b97a-3d6f666c5207"
}
4.1.43.2 - 1.1
put /v1/volumes/{volume_id}/size
Description
Increase the volume capacity.
Volume capacity can only be increased, reduction is not supported.
When increasing capacity, recovery is possible only by creating new volume from a previously taken snapshot (i.e., the snapshot can be used solely for the new‑volume creation method).
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | volume_id required | Volume ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string | None |
| body | body required | VolumeExtendRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | VolumeShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/volumes/{volume_id}/size
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"size": 104
}
Example HTTP response
Response 202
{
"bootable": false,
"created_at": "2026-04-14T15:06:25.639Z",
"encrypted": true,
"id": "3f500f00-ed80-4566-a057-e31760226f9a",
"modified_at": "2025-07-26T12:00:00Z",
"multiattach": false,
"name": "volume01",
"servers": [
{
"attached_at": "2026-04-14T15:06:25.639Z",
"device": "/dev/vda",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
}
],
"size": 104,
"snapshot_id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"state": "available",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_image_metadata": {
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"disk_format": "qcow2",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"min_disk": 100,
"min_ram": 0,
"os_distro": "alma",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"signature_verified": false,
"size": 2429747200
},
"volume_type": "SSD",
"volume_type_id": "c643ac35-3aec-43e6-b97a-3d6f666c5207"
}
4.1.43.3 - 1.0
put /v1/volumes/{volume_id}/size
Description
Increase the volume capacity.
Volume capacity can only be increased, reduction is not supported.
When increasing capacity, recovery is possible only by creating new volume from a previously taken snapshot (i.e., the snapshot can be used solely for the new‑volume creation method).
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | volume_id required | Volume ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string | None |
| body | body required | VolumeExtendRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | VolumeShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/volumes/{volume_id}/size
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"size": 104
}
Example HTTP response
Response 202
{
"bootable": false,
"created_at": "2026-04-14T15:06:23.140Z",
"encrypted": true,
"id": "3f500f00-ed80-4566-a057-e31760226f9a",
"modified_at": "2025-07-26T12:00:00Z",
"multiattach": false,
"name": "volume01",
"servers": [
{
"attached_at": "2026-04-14T15:06:23.141Z",
"device": "/dev/vda",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
}
],
"size": 104,
"snapshot_id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"state": "available",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_image_metadata": {
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"disk_format": "qcow2",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"min_disk": 100,
"min_ram": 0,
"os_distro": "alma",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"signature_verified": false,
"size": 2429747200
},
"volume_type": "SSD",
"volume_type_id": "c643ac35-3aec-43e6-b97a-3d6f666c5207"
}
4.1.44 - Get region's maximum partition size.
4.1.44.1 - 1.2
get /v1/server-groups/partition-size
Description
Get region’s maximum partition size
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerGroupPartitionSizeResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/server-groups/partition-size
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"partition_size": ""
}
4.1.44.2 - 1.1
get /v1/server-groups/partition-size
Description
Get region’s maximum partition size
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerGroupPartitionSizeResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/server-groups/partition-size
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"partition_size": ""
}
4.1.44.3 - 1.0
get /v1/server-groups/partition-size
Description
Get region’s maximum partition size
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerGroupPartitionSizeResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/server-groups/partition-size
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"partition_size": ""
}
4.1.45 - Import Image
4.1.45.1 - 1.2
post /v1/images/{image_id}/import
Description
Connect an external image file to use as an image resource.
You need the URL of the image file uploaded to Object Storage.
The Object Storage bucket containing the image must be in the same zone as the server you are creating.
The image file must have a .qcow2 extension.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | image_id required | Image ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | None |
| body | body required | ImageImportRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/images/{image_id}/import
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"url": "https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2"
}
Example HTTP response
Response 202
4.1.45.2 - 1.1
post /v1/images/{image_id}/import
Description
Connect an external image file to use as an image resource.
You need the URL of the image file uploaded to Object Storage.
The Object Storage bucket containing the image must be in the same zone as the server you are creating.
The image file must have a .qcow2 extension.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | image_id required | Image ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | None |
| body | body required | ImageImportRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/images/{image_id}/import
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"url": "https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2"
}
Example HTTP response
Response 202
4.1.45.3 - 1.0
post /v1/images/{image_id}/import
Description
Connect an external image file to use as an image resource.
You need the URL of the image file uploaded to Object Storage.
The Object Storage bucket containing the image must be in the same zone as the server you are creating.
The image file must have a .qcow2 extension.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | image_id required | Image ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | None |
| body | body required | ImageImportRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/images/{image_id}/import
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"url": "https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2"
}
Example HTTP response
Response 202
4.1.46 - List Auto-Scaling Group LB Server Groups
4.1.46.1 - 1.2
get /v1/auto-scaling-groups/{auto_scaling_group_id}/lb-server-groups
Description
List Auto-Scaling Group LB Server Groups.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| query | offset optional | Index of where to start in the list Example : 0 | any of [integer, null] | 0 |
| query | limit optional | Page size of items Example : 20 | any of [integer, null] | 20 |
| query | sort optional | Comma-separated list of sort keys and optional sort directions in the form of Example : created_at:desc | any of [string, null] | created_at:desc,id:desc |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupLbServerGroupListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/lb-server-groups
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"count": 20,
"lb_server_groups": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "lb-server-group-name",
"port": 8080
}
]
}
4.1.46.2 - 1.1
get /v1/auto-scaling-groups/{auto_scaling_group_id}/lb-server-groups
Description
List Auto-Scaling Group LB Server Groups.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| query | offset optional | Index of where to start in the list Example : 0 | any of [integer, null] | 0 |
| query | limit optional | Page size of items Example : 20 | any of [integer, null] | 20 |
| query | sort optional | Comma-separated list of sort keys and optional sort directions in the form of Example : created_at:desc | any of [string, null] | created_at:desc,id:desc |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupLbServerGroupListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/lb-server-groups
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"count": 20,
"lb_server_groups": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "lb-server-group-name",
"port": 8080
}
]
}
4.1.46.3 - 1.0
get /v1/auto-scaling-groups/{auto_scaling_group_id}/lb-server-groups
Description
List Auto-Scaling Group LB Server Groups.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| query | offset optional | Index of where to start in the list Example : 0 | any of [integer, null] | 0 |
| query | limit optional | Page size of items Example : 20 | any of [integer, null] | 20 |
| query | sort optional | Comma-separated list of sort keys and optional sort directions in the form of Example : created_at:desc | any of [string, null] | created_at:desc,id:desc |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupLbServerGroupListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/lb-server-groups
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"count": 20,
"lb_server_groups": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "lb-server-group-name",
"port": 8080
}
]
}
4.1.47 - List Auto-Scaling Group Notifications
4.1.47.1 - 1.2
get /v1/auto-scaling-groups/{auto_scaling_group_id}/notifications
Description
List Auto-Scaling Group notifications.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| query | user_ids optional | User ID list Example : ['570907805e5447be84b618450ef52o0t'] | any of [array[string], null] | [] |
| query | notification_state optional | Auto-Scaling Group notification state Example : ACTIVE | any of [string, null] | [] |
| query | notification_event optional | Auto-Scaling Group notification event Example : SCALE_OUT | any of [string, null] | [] |
| query | offset optional | Index of where to start in the list Example : 0 | any of [integer, null] | 0 |
| query | limit optional | Page size of items Example : 20 | any of [integer, null] | 20 |
| query | sort optional | Comma-separated list of sort keys and optional sort directions in the form of Example : created_at:desc | any of [string, null] | created_at:desc |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupNotificationListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/notifications
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"count": 20,
"notifications": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"notification_events": [
"SCALE_OUT",
"SCALE_OUT_FAIL"
],
"notification_state": "ACTIVE",
"user_email": "scpuser@samsung.com",
"user_id": "570907805e5447be84b618450ef52o0t",
"user_name": "scpuser"
}
]
}
4.1.47.2 - 1.1
get /v1/auto-scaling-groups/{auto_scaling_group_id}/notifications
Description
List Auto-Scaling Group notifications.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| query | user_ids optional | User ID list Example : ['570907805e5447be84b618450ef52o0t'] | any of [array[string], null] | [] |
| query | notification_state optional | Auto-Scaling Group notification state Example : ACTIVE | any of [string, null] | [] |
| query | notification_event optional | Auto-Scaling Group notification event Example : SCALE_OUT | any of [string, null] | [] |
| query | offset optional | Index of where to start in the list Example : 0 | any of [integer, null] | 0 |
| query | limit optional | Page size of items Example : 20 | any of [integer, null] | 20 |
| query | sort optional | Comma-separated list of sort keys and optional sort directions in the form of Example : created_at:desc | any of [string, null] | created_at:desc |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupNotificationListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/notifications
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"count": 20,
"notifications": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"notification_events": [
"SCALE_OUT",
"SCALE_OUT_FAIL"
],
"notification_state": "ACTIVE",
"user_email": "scpuser@samsung.com",
"user_id": "570907805e5447be84b618450ef52o0t",
"user_name": "scpuser"
}
]
}
4.1.47.3 - 1.0
get /v1/auto-scaling-groups/{auto_scaling_group_id}/notifications
Description
List Auto-Scaling Group notifications.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| query | user_ids optional | User ID list Example : ['570907805e5447be84b618450ef52o0t'] | any of [array[string], null] | [] |
| query | notification_state optional | Auto-Scaling Group notification state Example : ACTIVE | any of [string, null] | [] |
| query | notification_event optional | Auto-Scaling Group notification event Example : SCALE_OUT | any of [string, null] | [] |
| query | offset optional | Index of where to start in the list Example : 0 | any of [integer, null] | 0 |
| query | limit optional | Page size of items Example : 20 | any of [integer, null] | 20 |
| query | sort optional | Comma-separated list of sort keys and optional sort directions in the form of Example : created_at:desc | any of [string, null] | created_at:desc |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupNotificationListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/notifications
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"count": 20,
"notifications": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"notification_events": [
"SCALE_OUT",
"SCALE_OUT_FAIL"
],
"notification_state": "ACTIVE",
"user_email": "scpuser@samsung.com",
"user_id": "570907805e5447be84b618450ef52o0t",
"user_name": "scpuser"
}
]
}
4.1.48 - List Auto-Scaling Group Policies
4.1.48.1 - 1.2
get /v1/auto-scaling-groups/{auto_scaling_group_id}/policies
Description
List Auto-Scaling Group policies.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| query | name optional | Policy name Example : policy-name | any of [string, null] | None |
| query | metric_method optional | Metric method Example : AVG | any of [enum (AVG, MIN, MAX), null] | None |
| query | metric_type optional | Metric type Example : CPU | any of [string, null] | None |
| query | scale_type optional | Scale type Example : SCALE_OUT | any of [enum (SCALE_OUT, SCALE_IN), null] | None |
| query | offset optional | Index of where to start in the list Example : 0 | any of [integer, null] | 0 |
| query | limit optional | Page size of items Example : 20 | any of [integer, null] | 20 |
| query | sort optional | Comma-separated list of sort keys and optional sort directions in the form of Example : created_at:desc | any of [string, null] | created_at:desc,id:desc |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupPolicyListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/policies
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"count": 20,
"policies": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"comparison_operator": "ge",
"cooldown_seconds": 300,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"evaluation_minutes": 5,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"metric_method": "AVG",
"metric_type": "CPU",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "policy-name",
"scale_method": "AMOUNT",
"scale_type": "SCALE_OUT",
"scale_value": 10,
"state": "ACTIVE",
"threshold": 60,
"threshold_unit": "%"
}
]
}
4.1.48.2 - 1.1
get /v1/auto-scaling-groups/{auto_scaling_group_id}/policies
Description
List Auto-Scaling Group policies.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| query | name optional | Policy name Example : policy-name | any of [string, null] | None |
| query | metric_method optional | Metric method Example : AVG | any of [enum (AVG, MIN, MAX), null] | None |
| query | metric_type optional | Metric type Example : CPU | any of [string, null] | None |
| query | scale_type optional | Scale type Example : SCALE_OUT | any of [enum (SCALE_OUT, SCALE_IN), null] | None |
| query | offset optional | Index of where to start in the list Example : 0 | any of [integer, null] | 0 |
| query | limit optional | Page size of items Example : 20 | any of [integer, null] | 20 |
| query | sort optional | Comma-separated list of sort keys and optional sort directions in the form of Example : created_at:desc | any of [string, null] | created_at:desc,id:desc |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupPolicyListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/policies
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"count": 20,
"policies": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"comparison_operator": "ge",
"cooldown_seconds": 300,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"evaluation_minutes": 5,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"metric_method": "AVG",
"metric_type": "CPU",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "policy-name",
"scale_method": "AMOUNT",
"scale_type": "SCALE_OUT",
"scale_value": 10,
"state": "ACTIVE",
"threshold": 60,
"threshold_unit": "%"
}
]
}
4.1.48.3 - 1.0
get /v1/auto-scaling-groups/{auto_scaling_group_id}/policies
Description
List Auto-Scaling Group policies.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| query | name optional | Policy name Example : policy-name | any of [string, null] | None |
| query | metric_method optional | Metric method Example : AVG | any of [enum (AVG, MIN, MAX), null] | None |
| query | metric_type optional | Metric type Example : CPU | any of [string, null] | None |
| query | scale_type optional | Scale type Example : SCALE_OUT | any of [enum (SCALE_OUT, SCALE_IN), null] | None |
| query | offset optional | Index of where to start in the list Example : 0 | any of [integer, null] | 0 |
| query | limit optional | Page size of items Example : 20 | any of [integer, null] | 20 |
| query | sort optional | Comma-separated list of sort keys and optional sort directions in the form of Example : created_at:desc | any of [string, null] | created_at:desc,id:desc |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupPolicyListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/policies
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"count": 20,
"policies": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"comparison_operator": "ge",
"cooldown_seconds": 300,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"evaluation_minutes": 5,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"metric_method": "AVG",
"metric_type": "CPU",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "policy-name",
"scale_method": "AMOUNT",
"scale_type": "SCALE_OUT",
"scale_value": 10,
"state": "ACTIVE",
"threshold": 60,
"threshold_unit": "%"
}
]
}
4.1.49 - List Auto-Scaling Group Schedules
4.1.49.1 - 1.2
get /v1/auto-scaling-groups/{auto_scaling_group_id}/schedules
Description
Get Auto-Scaling Group schedule list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | frequency optional | Frequency Example : WEEKLY | any of [enum (ONCE, DAILY, WEEKLY, MONTHLY), null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupScheduleListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/schedules
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"schedules": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"day_of_month": "-1,1",
"day_of_week": "SU,SA",
"description": "description",
"desired_server_count": 1,
"end_date": "2025-01-01",
"frequency": "WEEKLY",
"hour": 9,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"max_server_count": 2,
"min_server_count": 1,
"minute": 0,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "schedulename",
"start_date": "2024-01-01",
"state": "ACTIVE",
"timezone": "Asia/Seoul"
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
4.1.49.2 - 1.1
get /v1/auto-scaling-groups/{auto_scaling_group_id}/schedules
Description
Get Auto-Scaling Group schedule list.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | frequency optional | Frequency Example : WEEKLY | any of [enum (ONCE, DAILY, WEEKLY, MONTHLY), null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupScheduleListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/schedules
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"schedules": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"day_of_month": "-1,1",
"day_of_week": "SU,SA",
"description": "description",
"desired_server_count": 1,
"end_date": "2025-01-01",
"frequency": "WEEKLY",
"hour": 9,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"max_server_count": 2,
"min_server_count": 1,
"minute": 0,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "schedulename",
"start_date": "2024-01-01",
"state": "ACTIVE",
"timezone": "Asia/Seoul"
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
4.1.49.3 - 1.0
get /v1/auto-scaling-groups/{auto_scaling_group_id}/schedules
Description
Get Auto-Scaling Group schedule list.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | frequency optional | Frequency Example : WEEKLY | any of [enum (ONCE, DAILY, WEEKLY, MONTHLY), null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupScheduleListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/schedules
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"schedules": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"day_of_month": "-1,1",
"day_of_week": "SU,SA",
"description": "description",
"desired_server_count": 1,
"end_date": "2025-01-01",
"frequency": "WEEKLY",
"hour": 9,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"max_server_count": 2,
"min_server_count": 1,
"minute": 0,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "schedulename",
"start_date": "2024-01-01",
"state": "ACTIVE",
"timezone": "Asia/Seoul"
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
4.1.50 - List Auto-Scaling Group Virtual Servers
4.1.50.1 - 1.2
get /v1/auto-scaling-groups/{auto_scaling_group_id}/virtual-servers
Description
List Auto-Scaling Group Virtual Servers.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| query | marker optional | The last item’s ID from previous request Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | any of [string, null] | None |
| query | limit optional | Page size of items Example : 20 | any of [integer, null] | 20 |
| query | sort optional | Comma-separated list of sort keys and optional sort directions in the form of Example : created_at:desc | any of [string, null] | created_at:desc |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupVirtualServerListResponseV1Dot2 |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/virtual-servers
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"servers": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"addresses": [
{
"ip_addresses": [
{
"ip_address": "192.169.3.2",
"version": 4
}
],
"subnet_name": "subnetname"
}
],
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2026-04-14T15:06:26.202Z",
"created_by": "97e6b22c9a4143789ca522df7457a32f",
"disk_config": "MANUAL",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"is_asg_virtual_server_healthy": true,
"is_lb_healthy": true,
"is_marketplace": false,
"keypair_name": "keypairname",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"lb_linked_state": "ATTACHED",
"locked": false,
"metadata": "",
"modified_at": "2026-04-14T15:06:26.202Z",
"name": "servername",
"partition_number": 1,
"planned_compute_os_type": "windows",
"product_category": "compute",
"product_offering": "virtual_server",
"security_groups": [
{
"name": "securitygroup"
}
],
"server_group_id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"server_type": {
"disk": 100,
"ephemeral": 0,
"extra_specs": "",
"id": "s1v1m2",
"name": "s1v1m2",
"ram": 2,
"swap": 0,
"vcpus": 1
},
"state": "ACTIVE",
"volumes": [
{
"delete_on_termination": false,
"id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
],
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
]
}
4.1.50.2 - 1.1
get /v1/auto-scaling-groups/{auto_scaling_group_id}/virtual-servers
Description
List Auto-Scaling Group Virtual Servers.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| query | marker optional | The last item’s ID from previous request Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | any of [string, null] | None |
| query | limit optional | Page size of items Example : 20 | any of [integer, null] | 20 |
| query | sort optional | Comma-separated list of sort keys and optional sort directions in the form of Example : created_at:desc | any of [string, null] | created_at:desc |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupVirtualServerListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/virtual-servers
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"servers": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"addresses": [
{
"ip_addresses": [
{
"ip_address": "192.169.3.2",
"version": 4
}
],
"subnet_name": "subnetname"
}
],
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2026-04-14T15:06:23.746Z",
"created_by": "97e6b22c9a4143789ca522df7457a32f",
"disk_config": "MANUAL",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"is_marketplace": false,
"keypair_name": "keypairname",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"lb_linked_state": "ATTACHED",
"locked": false,
"metadata": "",
"modified_at": "2026-04-14T15:06:23.746Z",
"name": "servername",
"partition_number": 1,
"planned_compute_os_type": "windows",
"product_category": "compute",
"product_offering": "virtual_server",
"security_groups": [
{
"name": "securitygroup"
}
],
"server_group_id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"server_type": {
"disk": 100,
"ephemeral": 0,
"extra_specs": "",
"id": "s1v1m2",
"name": "s1v1m2",
"ram": 2,
"swap": 0,
"vcpus": 1
},
"state": "ACTIVE",
"volumes": [
{
"delete_on_termination": false,
"id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
],
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
]
}
4.1.50.3 - 1.0
get /v1/auto-scaling-groups/{auto_scaling_group_id}/virtual-servers
Description
List Auto-Scaling Group Virtual Servers.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| query | marker optional | The last item’s ID from previous request Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | any of [string, null] | None |
| query | limit optional | Page size of items Example : 20 | any of [integer, null] | 20 |
| query | sort optional | Comma-separated list of sort keys and optional sort directions in the form of Example : created_at:desc | any of [string, null] | created_at:desc |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupVirtualServerListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/virtual-servers
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"servers": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"addresses": [
{
"ip_addresses": [
{
"ip_address": "192.169.3.2",
"version": 4
}
],
"subnet_name": "subnetname"
}
],
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2026-04-14T15:06:21.206Z",
"created_by": "97e6b22c9a4143789ca522df7457a32f",
"disk_config": "MANUAL",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"is_marketplace": false,
"keypair_name": "keypairname",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"lb_linked_state": "ATTACHED",
"locked": false,
"metadata": "",
"modified_at": "2026-04-14T15:06:21.206Z",
"name": "servername",
"partition_number": 1,
"planned_compute_os_type": "windows",
"product_category": "compute",
"product_offering": "virtual_server",
"security_groups": [
{
"name": "securitygroup"
}
],
"server_group_id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"server_type": {
"disk": 100,
"ephemeral": 0,
"extra_specs": "",
"id": "s1v1m2",
"name": "s1v1m2",
"ram": 2,
"swap": 0,
"vcpus": 1
},
"state": "ACTIVE",
"volumes": [
{
"delete_on_termination": false,
"id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
],
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
]
}
4.1.51 - List Auto-Scaling Groups
4.1.51.1 - 1.2
get /v1/auto-scaling-groups
Description
List Auto-Scaling Groups.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | name optional | Auto-Scaling Group name Example : auto-scaling-group-name | any of [string, null] | None |
| query | state optional | Auto-Scaling Group state Example : IN_SERVICE | any of [string, null] | None |
| query | launch_configuration_id optional | Launch Configuration ID Example : b5aea5a675fc4f6b9e0fcd1288354c5f | any of [string, null] | None |
| query | launch_configuration_name optional | Launch Configuration name Example : launch-configuration-name | any of [string, null] | None |
| query | lb_server_group_id optional | LB Server Group ID Example : d06e87d3-ca9a-461b-8e88-077a542a7335 | any of [string, null] | None |
| query | security_group_id optional | Security Group ID Example : c09c3f05-03d9-443f-b27a-40e0f973c75f | any of [string, null] | None |
| query | subnet_id optional | Subnet ID Example : 78b2ee3f074145c580ab6abac4821f97 | any of [string, null] | None |
| query | vpc_id optional | VPC ID Example : cc976b621087484ea5fd527f4b78708b | any of [string, null] | None |
| query | created_by optional | Created by Example : 97e6b22c9a4143789ca522df7457a32f | any of [string, null] | None |
| query | offset optional | Index of where to start in the list Example : 0 | any of [integer, null] | 0 |
| query | limit optional | Page size of items Example : 20 | any of [integer, null] | 20 |
| query | sort optional | Comma-separated list of sort keys and optional sort directions in the form of Example : created_at:desc | any of [string, null] | created_at:desc,id:desc |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupListResponseV1Dot2 |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/auto-scaling-groups
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"auto_scaling_groups": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"desired_server_count": 1,
"desired_server_count_editable": true,
"drain_enabled": true,
"drain_timeout": 300,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"launch_configuration_name": "launch-configuration-name",
"lb_server_groups": [],
"max_server_count": 2,
"min_server_count": 1,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "auto-scaling-group-name",
"security_group_ids": [
"c09c3f05-03d9-443f-b27a-40e0f973c75f"
],
"server_name_prefix": "server-name-prefix",
"state": "IN_SERVICE",
"state_check_delay_time": 300,
"subnet_ids": [],
"use_lb_state_check": true,
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
],
"count": 20
}
4.1.51.2 - 1.1
get /v1/auto-scaling-groups
Description
List Auto-Scaling Groups.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | name optional | Auto-Scaling Group name Example : auto-scaling-group-name | any of [string, null] | None |
| query | state optional | Auto-Scaling Group state Example : IN_SERVICE | any of [string, null] | None |
| query | launch_configuration_id optional | Launch Configuration ID Example : b5aea5a675fc4f6b9e0fcd1288354c5f | any of [string, null] | None |
| query | launch_configuration_name optional | Launch Configuration name Example : launch-configuration-name | any of [string, null] | None |
| query | lb_server_group_id optional | LB Server Group ID Example : d06e87d3-ca9a-461b-8e88-077a542a7335 | any of [string, null] | None |
| query | security_group_id optional | Security Group ID Example : c09c3f05-03d9-443f-b27a-40e0f973c75f | any of [string, null] | None |
| query | subnet_id optional | Subnet ID Example : 78b2ee3f074145c580ab6abac4821f97 | any of [string, null] | None |
| query | vpc_id optional | VPC ID Example : cc976b621087484ea5fd527f4b78708b | any of [string, null] | None |
| query | created_by optional | Created by Example : 97e6b22c9a4143789ca522df7457a32f | any of [string, null] | None |
| query | offset optional | Index of where to start in the list Example : 0 | any of [integer, null] | 0 |
| query | limit optional | Page size of items Example : 20 | any of [integer, null] | 20 |
| query | sort optional | Comma-separated list of sort keys and optional sort directions in the form of Example : created_at:desc | any of [string, null] | created_at:desc,id:desc |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/auto-scaling-groups
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"auto_scaling_groups": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"desired_server_count": 1,
"desired_server_count_editable": true,
"drain_enabled": true,
"drain_timeout": 300,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"launch_configuration_name": "launch-configuration-name",
"lb_server_groups": [],
"max_server_count": 2,
"min_server_count": 1,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "auto-scaling-group-name",
"security_group_ids": [
"c09c3f05-03d9-443f-b27a-40e0f973c75f"
],
"server_name_prefix": "server-name-prefix",
"state": "IN_SERVICE",
"subnet_ids": [],
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
],
"count": 20
}
4.1.51.3 - 1.0
get /v1/auto-scaling-groups
Description
List Auto-Scaling Groups.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | name optional | Auto-Scaling Group name Example : auto-scaling-group-name | any of [string, null] | None |
| query | state optional | Auto-Scaling Group state Example : IN_SERVICE | any of [string, null] | None |
| query | launch_configuration_id optional | Launch Configuration ID Example : b5aea5a675fc4f6b9e0fcd1288354c5f | any of [string, null] | None |
| query | launch_configuration_name optional | Launch Configuration name Example : launch-configuration-name | any of [string, null] | None |
| query | lb_server_group_id optional | LB Server Group ID Example : d06e87d3-ca9a-461b-8e88-077a542a7335 | any of [string, null] | None |
| query | security_group_id optional | Security Group ID Example : c09c3f05-03d9-443f-b27a-40e0f973c75f | any of [string, null] | None |
| query | subnet_id optional | Subnet ID Example : 78b2ee3f074145c580ab6abac4821f97 | any of [string, null] | None |
| query | vpc_id optional | VPC ID Example : cc976b621087484ea5fd527f4b78708b | any of [string, null] | None |
| query | created_by optional | Created by Example : 97e6b22c9a4143789ca522df7457a32f | any of [string, null] | None |
| query | offset optional | Index of where to start in the list Example : 0 | any of [integer, null] | 0 |
| query | limit optional | Page size of items Example : 20 | any of [integer, null] | 20 |
| query | sort optional | Comma-separated list of sort keys and optional sort directions in the form of Example : created_at:desc | any of [string, null] | created_at:desc,id:desc |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/auto-scaling-groups
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"auto_scaling_groups": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"desired_server_count": 1,
"desired_server_count_editable": true,
"drain_enabled": true,
"drain_timeout": 300,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"launch_configuration_name": "launch-configuration-name",
"lb_server_groups": [],
"max_server_count": 2,
"min_server_count": 1,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "auto-scaling-group-name",
"security_group_ids": [
"c09c3f05-03d9-443f-b27a-40e0f973c75f"
],
"server_name_prefix": "server-name-prefix",
"state": "IN_SERVICE",
"subnet_ids": [],
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
],
"count": 20
}
4.1.52 - List Default Configs
4.1.52.1 - 1.2
get /v1/default-configs
Description
Retrieves a list of default configuration values, including resource‑usage limits, thresholds, and related settings.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | name optional | Name Example : key | any of [string, null] | None |
| query | category optional | Category Example : AUTO_SCALING_GROUP | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | DefaultConfigListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/default-configs
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"configs": "('key': 'value'}",
"count": 20
}
4.1.52.2 - 1.1
get /v1/default-configs
Description
Retrieves a list of default configuration values, including resource‑usage limits, thresholds, and related settings.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | name optional | Name Example : key | any of [string, null] | None |
| query | category optional | Category Example : AUTO_SCALING_GROUP | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | DefaultConfigListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/default-configs
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"configs": "('key': 'value'}",
"count": 20
}
4.1.52.3 - 1.0
get /v1/default-configs
Description
Retrieves a list of default configuration values, including resource‑usage limits, thresholds, and related settings.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | name optional | Name Example : key | any of [string, null] | None |
| query | category optional | Category Example : AUTO_SCALING_GROUP | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | DefaultConfigListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/default-configs
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"configs": "('key': 'value'}",
"count": 20
}
4.1.53 - List Image members
4.1.53.1 - 1.2
get /v1/images/{image_id}/members
Description
Retrieves the list of account members with whom the image owner has shared the image.
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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | image_id required | Image ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ImageMemberListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/images/{image_id}/members
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"members": [
{
"created_at": "2025-07-22T09:00:00Z",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"member_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"status": "pending",
"updated_at": "2025-07-26T12:00:00Z"
}
]
}
4.1.53.2 - 1.1
get /v1/images/{image_id}/members
Description
Retrieves the list of account members with whom the image owner has shared the image.
You can request image sharing between accounts.
Image members have read‑only permission on the image.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | image_id required | Image ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ImageMemberListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/images/{image_id}/members
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"members": [
{
"created_at": "2025-07-22T09:00:00Z",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"member_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"status": "pending",
"updated_at": "2025-07-26T12:00:00Z"
}
]
}
4.1.53.3 - 1.0
get /v1/images/{image_id}/members
Description
Retrieves the list of account members with whom the image owner has shared the image.
You can request image sharing between accounts.
Image members have read‑only permission on the image.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | image_id required | Image ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ImageMemberListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/images/{image_id}/members
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"members": [
{
"created_at": "2025-07-22T09:00:00Z",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"member_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"status": "pending",
"updated_at": "2025-07-26T12:00:00Z"
}
]
}
4.1.54 - List Images
4.1.54.1 - 1.2
get /v1/images
Description
List Images.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | limit optional | Page size of items Example : 20 | any of [integer, null] | 20 |
| query | marker optional | The last item’s ID from previous request Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | any of [string, null] | None |
| query | scp_image_type optional | Image type Example : custom | any of [string, null] | None |
| query | scp_original_image_type optional | Original Image type Example : standard | any of [string, null] | None |
| query | name optional | Image name Example : imagename | any of [string, null] | None |
| query | os_distro optional | OS distribution of the image to be uploaded Example : alma | any of [string, null] | None |
| query | status optional | Image status Example : active | any of [string, null] | None |
| query | visibility optional | Indicates access permissions for the Image. Private: Can be used only within the Account, Shared: Can be shared between Accounts Example : private | any of [enum (public, community, shared, private), null] | None |
| query | sort optional | Comma-separated list of sort keys and optional sort directions in the form of Example : created_at:desc | any of [string, null] | created_at:desc |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ImageListResponseV1Dot2 |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/images
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"images": [
{
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"created_at": "2025-07-22T09:00:00Z",
"disk_format": "qcow2",
"file": "/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file",
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"min_disk": 100,
"min_ram": 0,
"name": "imagename",
"os_distro": "alma",
"os_hash_algo": "sha512",
"os_hash_value": "c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99",
"os_hidden": false,
"owner": "a8f10467abfc4b87b64614ab36eb9ae4",
"owner_account_name": "AccountName",
"owner_user_name": "user@samsung.com",
"protected": false,
"root_device_name": "/dev/vda",
"scp_gpu_driver": "535.183.06",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"scp_os_build_version": "20250101",
"scp_os_version": "8.8",
"size": 2429747200,
"status": "active",
"updated_at": "2025-07-26T12:00:00Z",
"url": "https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2",
"virtual_size": 17179869184,
"visibility": "private",
"volumes": "[{\"tag\": null, \"volume_id\": null, \"encryption_options\": null, \"encryption_secret_uuid\": null, \"encryption_format\": null, \"device_name\": \"/dev/vda\", \"disk_bus\": \"virtio\", \"volume_type\": null, \"encrypted\": null, \"image_id\": null, \"device_type\": \"disk\", \"source_type\": \"snapshot\", \"delete_on_termination\": false, \"volume_size\": 104, \"guest_format\": null, \"boot_index\": 0, \"destination_type\": \"volume\", \"snapshot_id\": \"abde9e38-2ed5-4ecd-b23c-b0120e30690e\", \"no_device\": null}]"
}
]
}
4.1.54.2 - 1.1
get /v1/images
Description
List Images.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | limit optional | Page size of items Example : 20 | any of [integer, null] | 20 |
| query | marker optional | The last item’s ID from previous request Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | any of [string, null] | None |
| query | scp_image_type optional | Image type Example : custom | any of [string, null] | None |
| query | scp_original_image_type optional | Original Image type Example : standard | any of [string, null] | None |
| query | name optional | Image name Example : imagename | any of [string, null] | None |
| query | os_distro optional | OS distribution of the image to be uploaded Example : alma | any of [string, null] | None |
| query | status optional | Image status Example : active | any of [string, null] | None |
| query | visibility optional | Indicates access permissions for the Image. Private: Can be used only within the Account, Shared: Can be shared between Accounts Example : private | any of [enum (public, community, shared, private), null] | None |
| query | sort optional | Comma-separated list of sort keys and optional sort directions in the form of Example : created_at:desc | any of [string, null] | created_at:desc |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ImageListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/images
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"images": [
{
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"created_at": "2025-07-22T09:00:00Z",
"disk_format": "qcow2",
"file": "/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file",
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"min_disk": 100,
"min_ram": 0,
"name": "imagename",
"os_distro": "alma",
"os_hash_algo": "sha512",
"os_hash_value": "c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99",
"os_hidden": false,
"owner": "a8f10467abfc4b87b64614ab36eb9ae4",
"owner_account_name": "AccountName",
"owner_user_name": "user@samsung.com",
"protected": false,
"root_device_name": "/dev/vda",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"scp_os_build_version": "20250101",
"scp_os_version": "8.8",
"size": 2429747200,
"status": "active",
"updated_at": "2025-07-26T12:00:00Z",
"url": "https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2",
"virtual_size": 17179869184,
"visibility": "private",
"volumes": "[{\"tag\": null, \"volume_id\": null, \"encryption_options\": null, \"encryption_secret_uuid\": null, \"encryption_format\": null, \"device_name\": \"/dev/vda\", \"disk_bus\": \"virtio\", \"volume_type\": null, \"encrypted\": null, \"image_id\": null, \"device_type\": \"disk\", \"source_type\": \"snapshot\", \"delete_on_termination\": false, \"volume_size\": 104, \"guest_format\": null, \"boot_index\": 0, \"destination_type\": \"volume\", \"snapshot_id\": \"abde9e38-2ed5-4ecd-b23c-b0120e30690e\", \"no_device\": null}]"
}
]
}
4.1.54.3 - 1.0
get /v1/images
Description
List Images.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | limit optional | Page size of items Example : 20 | any of [integer, null] | 20 |
| query | marker optional | The last item’s ID from previous request Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | any of [string, null] | None |
| query | scp_image_type optional | Image type Example : custom | any of [string, null] | None |
| query | scp_original_image_type optional | Original Image type Example : standard | any of [string, null] | None |
| query | name optional | Image name Example : imagename | any of [string, null] | None |
| query | os_distro optional | OS distribution of the image to be uploaded Example : alma | any of [string, null] | None |
| query | status optional | Image status Example : active | any of [string, null] | None |
| query | visibility optional | Indicates access permissions for the Image. Private: Can be used only within the Account, Shared: Can be shared between Accounts Example : private | any of [enum (public, community, shared, private), null] | None |
| query | sort optional | Comma-separated list of sort keys and optional sort directions in the form of Example : created_at:desc | any of [string, null] | created_at:desc |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ImageListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/images
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"images": [
{
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"created_at": "2025-07-22T09:00:00Z",
"disk_format": "qcow2",
"file": "/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file",
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"min_disk": 100,
"min_ram": 0,
"name": "imagename",
"os_distro": "alma",
"os_hash_algo": "sha512",
"os_hash_value": "c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99",
"os_hidden": false,
"owner": "a8f10467abfc4b87b64614ab36eb9ae4",
"owner_account_name": "AccountName",
"owner_user_name": "user@samsung.com",
"protected": false,
"root_device_name": "/dev/vda",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"scp_os_build_version": "20250101",
"scp_os_version": "8.8",
"size": 2429747200,
"status": "active",
"updated_at": "2025-07-26T12:00:00Z",
"url": "https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2",
"virtual_size": 17179869184,
"visibility": "private",
"volumes": "[{\"tag\": null, \"volume_id\": null, \"encryption_options\": null, \"encryption_secret_uuid\": null, \"encryption_format\": null, \"device_name\": \"/dev/vda\", \"disk_bus\": \"virtio\", \"volume_type\": null, \"encrypted\": null, \"image_id\": null, \"device_type\": \"disk\", \"source_type\": \"snapshot\", \"delete_on_termination\": false, \"volume_size\": 104, \"guest_format\": null, \"boot_index\": 0, \"destination_type\": \"volume\", \"snapshot_id\": \"abde9e38-2ed5-4ecd-b23c-b0120e30690e\", \"no_device\": null}]"
}
]
}
4.1.55 - List Keypairs
4.1.55.1 - 1.2
get /v1/keypairs
Description
Get keypair list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | limit optional | Page size of items Example : 20 | any of [integer, null] | None |
| query | marker optional | The last item’s ID from previous request Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | KeypairListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/keypairs
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"keypairs": [
{
"fingerprint": "7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd",
"name": "keypairname",
"public_key": "ssh-rsa fakeKey Generated-by-SCP",
"type": "ssh"
}
]
}
4.1.55.2 - 1.1
get /v1/keypairs
Description
Get keypair list.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | limit optional | Page size of items Example : 20 | any of [integer, null] | None |
| query | marker optional | The last item’s ID from previous request Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | KeypairListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/keypairs
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"keypairs": [
{
"fingerprint": "7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd",
"name": "keypairname",
"public_key": "ssh-rsa fakeKey Generated-by-SCP",
"type": "ssh"
}
]
}
4.1.55.3 - 1.0
get /v1/keypairs
Description
Get keypair list.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | limit optional | Page size of items Example : 20 | any of [integer, null] | None |
| query | marker optional | The last item’s ID from previous request Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | KeypairListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/keypairs
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"keypairs": [
{
"fingerprint": "7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd",
"name": "keypairname",
"public_key": "ssh-rsa fakeKey Generated-by-SCP",
"type": "ssh"
}
]
}
4.1.56 - List Launch Configurations
4.1.56.1 - 1.2
get /v1/launch-configurations
Description
List Launch Configurations.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | name optional | Launch Configuration name Example : launch-configuration-name | any of [string, null] | |
| query | image_id optional | Image ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | any of [string, null] | None |
| query | offset optional | Index of where to start in the list Example : 0 | any of [integer, null] | 0 |
| query | limit optional | Page size of items Example : 20 | any of [integer, null] | 20 |
| query | sort optional | Comma-separated list of sort keys and optional sort directions in the form of Example : created_at:asc | any of [string, null] | created_at:asc |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | LaunchConfigurationListResponseV1Dot2 |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/launch-configurations
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"count": 20,
"launch_configurations": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_count": 1,
"boot_disk_size": 104,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"extra_disk_size": 104,
"file_storage_ids": [
""
],
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"keypair_name": "keypairname",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "launch-configuration-name",
"public_key": "ssh-rsa fakeKey Generated-by-SCP",
"server_type_id": "s1v1m2",
"state": "ACTIVE",
"user_data": "IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==",
"volumes": [
{
"boot_index": 0,
"size": 104,
"type": "SSD"
}
]
}
]
}
4.1.56.2 - 1.1
get /v1/launch-configurations
Description
List Launch Configurations.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | name optional | Launch Configuration name Example : launch-configuration-name | any of [string, null] | |
| query | image_id optional | Image ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | any of [string, null] | None |
| query | offset optional | Index of where to start in the list Example : 0 | any of [integer, null] | 0 |
| query | limit optional | Page size of items Example : 20 | any of [integer, null] | 20 |
| query | sort optional | Comma-separated list of sort keys and optional sort directions in the form of Example : created_at:asc | any of [string, null] | created_at:asc |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | LaunchConfigurationListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/launch-configurations
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"count": 20,
"launch_configurations": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_count": 1,
"boot_disk_size": 104,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"extra_disk_size": 104,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"keypair_name": "keypairname",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "launch-configuration-name",
"public_key": "ssh-rsa fakeKey Generated-by-SCP",
"server_type_id": "s1v1m2",
"state": "ACTIVE",
"user_data": "IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==",
"volumes": [
{
"boot_index": 0,
"size": 104,
"type": "SSD"
}
]
}
]
}
4.1.56.3 - 1.0
get /v1/launch-configurations
Description
List Launch Configurations.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | name optional | Launch Configuration name Example : launch-configuration-name | any of [string, null] | |
| query | image_id optional | Image ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | any of [string, null] | None |
| query | offset optional | Index of where to start in the list Example : 0 | any of [integer, null] | 0 |
| query | limit optional | Page size of items Example : 20 | any of [integer, null] | 20 |
| query | sort optional | Comma-separated list of sort keys and optional sort directions in the form of Example : created_at:asc | any of [string, null] | created_at:asc |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | LaunchConfigurationListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/launch-configurations
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"count": 20,
"launch_configurations": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_count": 1,
"boot_disk_size": 104,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"extra_disk_size": 104,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"keypair_name": "keypairname",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "launch-configuration-name",
"public_key": "ssh-rsa fakeKey Generated-by-SCP",
"server_type_id": "s1v1m2",
"state": "ACTIVE",
"user_data": "IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==",
"volumes": [
{
"boot_index": 0,
"size": 104,
"type": "SSD"
}
]
}
]
}
4.1.57 - List pending Images
4.1.57.1 - 1.2
get /v1/pending-images
Description
Retrieve a list of images pending sharing.
Image sharing can be requested between accounts.
Member accounts that have been shared an image can view the pending‑share list and decide whether to accept or reject it.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | scp_image_type optional | Image type Example : custom | any of [string, null] | None |
| query | scp_original_image_type optional | Original Image type Example : standard | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ImageListResponseV1Dot2 |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/pending-images
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"images": [
{
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"created_at": "2025-07-22T09:00:00Z",
"disk_format": "qcow2",
"file": "/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file",
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"min_disk": 100,
"min_ram": 0,
"name": "imagename",
"os_distro": "alma",
"os_hash_algo": "sha512",
"os_hash_value": "c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99",
"os_hidden": false,
"owner": "a8f10467abfc4b87b64614ab36eb9ae4",
"owner_account_name": "AccountName",
"owner_user_name": "user@samsung.com",
"protected": false,
"root_device_name": "/dev/vda",
"scp_gpu_driver": "535.183.06",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"scp_os_build_version": "20250101",
"scp_os_version": "8.8",
"size": 2429747200,
"status": "active",
"updated_at": "2025-07-26T12:00:00Z",
"url": "https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2",
"virtual_size": 17179869184,
"visibility": "private",
"volumes": "[{\"tag\": null, \"volume_id\": null, \"encryption_options\": null, \"encryption_secret_uuid\": null, \"encryption_format\": null, \"device_name\": \"/dev/vda\", \"disk_bus\": \"virtio\", \"volume_type\": null, \"encrypted\": null, \"image_id\": null, \"device_type\": \"disk\", \"source_type\": \"snapshot\", \"delete_on_termination\": false, \"volume_size\": 104, \"guest_format\": null, \"boot_index\": 0, \"destination_type\": \"volume\", \"snapshot_id\": \"abde9e38-2ed5-4ecd-b23c-b0120e30690e\", \"no_device\": null}]"
}
]
}
4.1.57.2 - 1.1
get /v1/pending-images
Description
Retrieve a list of images pending sharing.
Image sharing can be requested between accounts.
Member accounts that have been shared an image can view the pending‑share list and decide whether to accept or reject it.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | scp_image_type optional | Image type Example : custom | any of [string, null] | None |
| query | scp_original_image_type optional | Original Image type Example : standard | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ImageListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/pending-images
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"images": [
{
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"created_at": "2025-07-22T09:00:00Z",
"disk_format": "qcow2",
"file": "/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file",
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"min_disk": 100,
"min_ram": 0,
"name": "imagename",
"os_distro": "alma",
"os_hash_algo": "sha512",
"os_hash_value": "c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99",
"os_hidden": false,
"owner": "a8f10467abfc4b87b64614ab36eb9ae4",
"owner_account_name": "AccountName",
"owner_user_name": "user@samsung.com",
"protected": false,
"root_device_name": "/dev/vda",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"scp_os_build_version": "20250101",
"scp_os_version": "8.8",
"size": 2429747200,
"status": "active",
"updated_at": "2025-07-26T12:00:00Z",
"url": "https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2",
"virtual_size": 17179869184,
"visibility": "private",
"volumes": "[{\"tag\": null, \"volume_id\": null, \"encryption_options\": null, \"encryption_secret_uuid\": null, \"encryption_format\": null, \"device_name\": \"/dev/vda\", \"disk_bus\": \"virtio\", \"volume_type\": null, \"encrypted\": null, \"image_id\": null, \"device_type\": \"disk\", \"source_type\": \"snapshot\", \"delete_on_termination\": false, \"volume_size\": 104, \"guest_format\": null, \"boot_index\": 0, \"destination_type\": \"volume\", \"snapshot_id\": \"abde9e38-2ed5-4ecd-b23c-b0120e30690e\", \"no_device\": null}]"
}
]
}
4.1.57.3 - 1.0
get /v1/pending-images
Description
Retrieve a list of images pending sharing.
Image sharing can be requested between accounts.
Member accounts that have been shared an image can view the pending‑share list and decide whether to accept or reject it.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | scp_image_type optional | Image type Example : custom | any of [string, null] | None |
| query | scp_original_image_type optional | Original Image type Example : standard | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ImageListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/pending-images
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"images": [
{
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"created_at": "2025-07-22T09:00:00Z",
"disk_format": "qcow2",
"file": "/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file",
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"min_disk": 100,
"min_ram": 0,
"name": "imagename",
"os_distro": "alma",
"os_hash_algo": "sha512",
"os_hash_value": "c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99",
"os_hidden": false,
"owner": "a8f10467abfc4b87b64614ab36eb9ae4",
"owner_account_name": "AccountName",
"owner_user_name": "user@samsung.com",
"protected": false,
"root_device_name": "/dev/vda",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"scp_os_build_version": "20250101",
"scp_os_version": "8.8",
"size": 2429747200,
"status": "active",
"updated_at": "2025-07-26T12:00:00Z",
"url": "https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2",
"virtual_size": 17179869184,
"visibility": "private",
"volumes": "[{\"tag\": null, \"volume_id\": null, \"encryption_options\": null, \"encryption_secret_uuid\": null, \"encryption_format\": null, \"device_name\": \"/dev/vda\", \"disk_bus\": \"virtio\", \"volume_type\": null, \"encrypted\": null, \"image_id\": null, \"device_type\": \"disk\", \"source_type\": \"snapshot\", \"delete_on_termination\": false, \"volume_size\": 104, \"guest_format\": null, \"boot_index\": 0, \"destination_type\": \"volume\", \"snapshot_id\": \"abde9e38-2ed5-4ecd-b23c-b0120e30690e\", \"no_device\": null}]"
}
]
}
4.1.58 - List Server Groups
4.1.58.1 - 1.2
get /v1/server-groups
Description
Get server group list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | limit optional | Page size of items Example : 20 | any of [integer, null] | None |
| query | offset optional | Index of where to start in the list Example : 0 | any of [integer, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerGroupListResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/server-groups
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"server_groups": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"members": [
"2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
],
"name": "server-group",
"partition_size": 3,
"policy": "anti-affinity",
"user_id": "570907805e5447be84b618450ef52o0t"
}
]
}
4.1.58.2 - 1.1
get /v1/server-groups
Description
Get server group list.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | limit optional | Page size of items Example : 20 | any of [integer, null] | None |
| query | offset optional | Index of where to start in the list Example : 0 | any of [integer, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerGroupListResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/server-groups
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"server_groups": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"members": [
"2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
],
"name": "server-group",
"partition_size": 3,
"policy": "anti-affinity",
"user_id": "570907805e5447be84b618450ef52o0t"
}
]
}
4.1.58.3 - 1.0
get /v1/server-groups
Description
Get server group list.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | limit optional | Page size of items Example : 20 | any of [integer, null] | None |
| query | offset optional | Index of where to start in the list Example : 0 | any of [integer, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerGroupListResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/server-groups
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"server_groups": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"members": [
"2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
],
"name": "server-group",
"partition_size": 3,
"policy": "anti-affinity",
"user_id": "570907805e5447be84b618450ef52o0t"
}
]
}
4.1.59 - List Server Interfaces
4.1.59.1 - 1.2
get /v1/servers/{server_id}/interfaces
Description
List Server Interfaces.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerInterfaceListResponseV1Dot2 |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"interfaces": [
{
"fixed_ips": [
{
"ip_address": "192.169.3.2"
}
],
"is_default": true,
"mac_addr": "fa:16:3e:c0:71:2b",
"port_id": "f2b02fc5-a5fd-4b5f-b1a9-987f4c0d66cc",
"port_state": "ACTIVE",
"private_static_nat": {
"external_ip_address": "182.197.61.81",
"id": "224b80106e6f41b38efe98ac9ddbf280",
"private_nat_ip_id": "1f0cb5390c40483592ddc5a282f53496",
"state": "ACTIVE"
},
"static_nat": {
"external_ip_address": "182.197.61.81",
"id": "224b80106e6f41b38efe98ac9ddbf280",
"publicip_id": "615fa9cd5cff486c9de679b3ce63e601",
"state": "ACTIVE"
},
"subnet_id": "183c6c30df0c4fcbb16422aa2d64aa21"
}
]
}
4.1.59.2 - 1.1
get /v1/servers/{server_id}/interfaces
Description
List Server Interfaces.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerInterfaceListResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"interfaces": [
{
"fixed_ips": [
{
"ip_address": "192.169.3.2"
}
],
"mac_addr": "fa:16:3e:c0:71:2b",
"port_id": "f2b02fc5-a5fd-4b5f-b1a9-987f4c0d66cc",
"port_state": "ACTIVE",
"private_static_nat": {
"external_ip_address": "182.197.61.81",
"id": "224b80106e6f41b38efe98ac9ddbf280",
"private_nat_ip_id": "1f0cb5390c40483592ddc5a282f53496",
"state": "ACTIVE"
},
"static_nat": {
"external_ip_address": "182.197.61.81",
"id": "224b80106e6f41b38efe98ac9ddbf280",
"publicip_id": "615fa9cd5cff486c9de679b3ce63e601",
"state": "ACTIVE"
},
"subnet_id": "183c6c30df0c4fcbb16422aa2d64aa21"
}
]
}
4.1.59.3 - 1.0
get /v1/servers/{server_id}/interfaces
Description
List Server Interfaces.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerInterfaceListResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"interfaces": [
{
"fixed_ips": [
{
"ip_address": "192.169.3.2"
}
],
"mac_addr": "fa:16:3e:c0:71:2b",
"port_id": "f2b02fc5-a5fd-4b5f-b1a9-987f4c0d66cc",
"port_state": "ACTIVE",
"private_static_nat": {
"external_ip_address": "182.197.61.81",
"id": "224b80106e6f41b38efe98ac9ddbf280",
"private_nat_ip_id": "1f0cb5390c40483592ddc5a282f53496",
"state": "ACTIVE"
},
"static_nat": {
"external_ip_address": "182.197.61.81",
"id": "224b80106e6f41b38efe98ac9ddbf280",
"publicip_id": "615fa9cd5cff486c9de679b3ce63e601",
"state": "ACTIVE"
},
"subnet_id": "183c6c30df0c4fcbb16422aa2d64aa21"
}
]
}
4.1.60 - List Server Ips
4.1.60.1 - 1.2
get /v1/servers/{server_id}/ips
Description
List Server Ips.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerIpsResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/servers/{server_id}/ips
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"addresses": [
{
"ip_addresses": [
{
"ip_address": "192.169.3.2",
"version": 4
}
],
"subnet_name": "subnetname"
}
]
}
4.1.60.2 - 1.1
get /v1/servers/{server_id}/ips
Description
List Server Ips.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerIpsResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/servers/{server_id}/ips
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"addresses": [
{
"ip_addresses": [
{
"ip_address": "192.169.3.2",
"version": 4
}
],
"subnet_name": "subnetname"
}
]
}
4.1.60.3 - 1.0
get /v1/servers/{server_id}/ips
Description
List Server Ips.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerIpsResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/servers/{server_id}/ips
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"addresses": [
{
"ip_addresses": [
{
"ip_address": "192.169.3.2",
"version": 4
}
],
"subnet_name": "subnetname"
}
]
}
4.1.61 - List Server Types
4.1.61.1 - 1.2
get /v1/server-types
Description
Get server type list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | limit optional | Page size of items Example : 20 | integer | None |
| query | marker optional | The last item’s ID from previous request Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| query | min_disk optional | Minimum disk size Example : 0 | integer | None |
| query | min_ram optional | Minimum ram size Example : 2048 | integer | None |
| query | sort optional | Comma-separated list of sort keys and optional sort directions in the form of Example : created_at:desc | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerTypeListResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/server-types
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"server_types": [
{
"description": "description",
"disk": 100,
"ephemeral": 0,
"extra_specs": "",
"id": "s1v1m2",
"name": "s1v1m2",
"ram": 2,
"swap": 0,
"vcpus": 1
}
]
}
4.1.61.2 - 1.1
get /v1/server-types
Description
Get server type list.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | limit optional | Page size of items Example : 20 | integer | None |
| query | marker optional | The last item’s ID from previous request Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| query | min_disk optional | Minimum disk size Example : 0 | integer | None |
| query | min_ram optional | Minimum ram size Example : 2048 | integer | None |
| query | sort optional | Comma-separated list of sort keys and optional sort directions in the form of Example : created_at:desc | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerTypeListResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/server-types
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"server_types": [
{
"description": "description",
"disk": 100,
"ephemeral": 0,
"extra_specs": "",
"id": "s1v1m2",
"name": "s1v1m2",
"ram": 2,
"swap": 0,
"vcpus": 1
}
]
}
4.1.61.3 - 1.0
get /v1/server-types
Description
Get server type list.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | limit optional | Page size of items Example : 20 | integer | None |
| query | marker optional | The last item’s ID from previous request Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| query | min_disk optional | Minimum disk size Example : 0 | integer | None |
| query | min_ram optional | Minimum ram size Example : 2048 | integer | None |
| query | sort optional | Comma-separated list of sort keys and optional sort directions in the form of Example : created_at:desc | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerTypeListResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/server-types
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"server_types": [
{
"description": "description",
"disk": 100,
"ephemeral": 0,
"extra_specs": "",
"id": "s1v1m2",
"name": "s1v1m2",
"ram": 2,
"swap": 0,
"vcpus": 1
}
]
}
4.1.62 - List Server Volumes
4.1.62.1 - 1.2
get /v1/servers/{server_id}/volumes
Description
List Server Volumes.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerVolumesResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/volumes
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"volumes": [
{
"delete_on_termination": false,
"device": "/dev/vda",
"id": "3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c",
"server_id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
]
}
4.1.62.2 - 1.1
get /v1/servers/{server_id}/volumes
Description
List Server Volumes.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerVolumesResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/volumes
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"volumes": [
{
"delete_on_termination": false,
"device": "/dev/vda",
"id": "3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c",
"server_id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
]
}
4.1.62.3 - 1.0
get /v1/servers/{server_id}/volumes
Description
List Server Volumes.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerVolumesResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/volumes
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"volumes": [
{
"delete_on_termination": false,
"device": "/dev/vda",
"id": "3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c",
"server_id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
]
}
4.1.63 - List snapshots
4.1.63.1 - 1.2
get /v1/snapshots
Description
List snapshots.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | volume_id optional | Volume ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | any of [string, null] | None |
| query | limit optional | Page size of items Example : 20 | any of [integer, null] | None |
| query | offset optional | Index of where to start in the list Example : 0 | any of [integer, null] | None |
| query | marker optional | The last item’s ID from previous request Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | any of [string, null] | None |
| query | with_count optional | Whether to show count Example : True | any of [boolean, null] | True |
| query | name optional | Snapshot name Example : snapshot-1 | any of [string, null] | None |
| query | sort optional | Comma-separated list of sort keys and optional sort directions in the form of Example : created_at:desc | any of [string, null] | created_at:desc |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SnapshotListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/snapshots
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"count": 100,
"snapshots": [
{
"created_at": "2025-07-22T09:00:00Z",
"description": "description",
"id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"metadata": "Metadata",
"name": "snapshot-1",
"size": 104,
"status": "available",
"updated_at": "2025-07-26T12:00:00Z",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
]
}
4.1.63.2 - 1.1
get /v1/snapshots
Description
List snapshots.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | volume_id optional | Volume ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | any of [string, null] | None |
| query | limit optional | Page size of items Example : 20 | any of [integer, null] | None |
| query | offset optional | Index of where to start in the list Example : 0 | any of [integer, null] | None |
| query | marker optional | The last item’s ID from previous request Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | any of [string, null] | None |
| query | with_count optional | Whether to show count Example : True | any of [boolean, null] | True |
| query | name optional | Snapshot name Example : snapshot-1 | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SnapshotListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/snapshots
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"count": 100,
"snapshots": [
{
"created_at": "2025-07-22T09:00:00Z",
"description": "description",
"id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"metadata": "Metadata",
"name": "snapshot-1",
"size": 104,
"status": "available",
"updated_at": "2025-07-26T12:00:00Z",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
]
}
4.1.63.3 - 1.0
get /v1/snapshots
Description
List snapshots.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | volume_id optional | Volume ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | any of [string, null] | None |
| query | limit optional | Page size of items Example : 20 | any of [integer, null] | None |
| query | offset optional | Index of where to start in the list Example : 0 | any of [integer, null] | None |
| query | marker optional | The last item’s ID from previous request Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | any of [string, null] | None |
| query | with_count optional | Whether to show count Example : True | any of [boolean, null] | True |
| query | name optional | Snapshot name Example : snapshot-1 | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SnapshotListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/snapshots
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"count": 100,
"snapshots": [
{
"created_at": "2025-07-22T09:00:00Z",
"description": "description",
"id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"metadata": "Metadata",
"name": "snapshot-1",
"size": 104,
"status": "available",
"updated_at": "2025-07-26T12:00:00Z",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
]
}
4.1.64 - List Virtual Server Security Group
4.1.64.1 - 1.2
get /v1/servers/{server_id}/security-groups
Description
List Virtual Server Security Group.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerSecurityGroupListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/security-groups
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"security_groups": [
{
"account_id": "6f70656e737461636b20342065766572",
"description": "Security group description",
"id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"name": "securitygroup",
"rules": [
{
"from_port": 1,
"id": "ca5cb96b-9df6-4af7-9682-4d60a58d38a5",
"ip_protocol": "tcp",
"ip_range": {
"cidr": "0.0.0.0/0"
},
"to_port": 65535
}
]
}
]
}
4.1.64.2 - 1.1
get /v1/servers/{server_id}/security-groups
Description
List Virtual Server Security Group.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerSecurityGroupListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/security-groups
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"security_groups": [
{
"account_id": "6f70656e737461636b20342065766572",
"description": "Security group description",
"id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"name": "securitygroup",
"rules": [
{
"from_port": 1,
"id": "ca5cb96b-9df6-4af7-9682-4d60a58d38a5",
"ip_protocol": "tcp",
"ip_range": {
"cidr": "0.0.0.0/0"
},
"to_port": 65535
}
]
}
]
}
4.1.64.3 - 1.0
get /v1/servers/{server_id}/security-groups
Description
List Virtual Server Security Group.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerSecurityGroupListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/security-groups
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"security_groups": [
{
"account_id": "6f70656e737461636b20342065766572",
"description": "Security group description",
"id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"name": "securitygroup",
"rules": [
{
"from_port": 1,
"id": "ca5cb96b-9df6-4af7-9682-4d60a58d38a5",
"ip_protocol": "tcp",
"ip_range": {
"cidr": "0.0.0.0/0"
},
"to_port": 65535
}
]
}
]
}
4.1.65 - List Virtual Servers
4.1.65.1 - 1.2
get /v1/servers
Description
List Virtual Servers.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | name optional | Server name Example : servername | any of [string, null] | None |
| query | ip optional | IP address Example : 192.169.3.2 | any of [string, null] | None |
| query | state optional | Server state Example : ACTIVE | any of [string, null] | None |
| query | product_category optional | Product category Example : compute | any of [enum (compute, container), null] | None |
| query | product_offering optional | Product offering Example : virtual_server | any of [array[enum (virtual_server, gpu_server, k8s_vm, k8s_gpu_vm)], enum (virtual_server, gpu_server, k8s_vm, k8s_gpu_vm), null] | None |
| query | vpc_id optional | VPC ID Example : cc976b621087484ea5fd527f4b78708b | any of [string, null] | None |
| query | server_type_id optional | Server type ID Example : s1v1m2 | any of [string, null] | None |
| query | limit optional | Page size of items Example : 20 | any of [integer, null] | None |
| query | marker optional | The last item’s ID from previous request Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | any of [string, null] | None |
| query | sort optional | Comma-separated list of sort keys and optional sort directions in the form of Example : created_at:desc | any of [string, null] | created_at:desc |
| query | auto_scaling_group_id optional | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/servers
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"servers": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"addresses": [
{
"ip_addresses": [
{
"ip_address": "192.169.3.2",
"version": 4
}
],
"subnet_name": "subnetname"
}
],
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2026-04-14T15:06:26.871Z",
"created_by": "97e6b22c9a4143789ca522df7457a32f",
"disk_config": "MANUAL",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"is_marketplace": false,
"keypair_name": "keypairname",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"locked": false,
"metadata": "",
"modified_at": "2026-04-14T15:06:26.871Z",
"name": "servername",
"partition_number": 1,
"planned_compute_os_type": "windows",
"product_category": "compute",
"product_offering": "virtual_server",
"security_groups": [
{
"name": "securitygroup"
}
],
"server_group_id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"server_type": {
"disk": 100,
"ephemeral": 0,
"extra_specs": "",
"id": "s1v1m2",
"name": "s1v1m2",
"ram": 2,
"swap": 0,
"vcpus": 1
},
"state": "ACTIVE",
"volumes": [
{
"delete_on_termination": false,
"id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
],
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
]
}
4.1.65.2 - 1.1
get /v1/servers
Description
List Virtual Servers.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | name optional | Server name Example : servername | any of [string, null] | None |
| query | ip optional | IP address Example : 192.169.3.2 | any of [string, null] | None |
| query | state optional | Server state Example : ACTIVE | any of [string, null] | None |
| query | product_category optional | Product category Example : compute | any of [enum (compute, container), null] | None |
| query | product_offering optional | Product offering Example : virtual_server | any of [array[enum (virtual_server, gpu_server, k8s_vm, k8s_gpu_vm)], enum (virtual_server, gpu_server, k8s_vm, k8s_gpu_vm), null] | None |
| query | vpc_id optional | VPC ID Example : cc976b621087484ea5fd527f4b78708b | any of [string, null] | None |
| query | server_type_id optional | Server type ID Example : s1v1m2 | any of [string, null] | None |
| query | limit optional | Page size of items Example : 20 | any of [integer, null] | None |
| query | marker optional | The last item’s ID from previous request Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | any of [string, null] | None |
| query | sort optional | Comma-separated list of sort keys and optional sort directions in the form of Example : created_at:desc | any of [string, null] | created_at:desc |
| query | auto_scaling_group_id optional | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/servers
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"servers": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"addresses": [
{
"ip_addresses": [
{
"ip_address": "192.169.3.2",
"version": 4
}
],
"subnet_name": "subnetname"
}
],
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2026-04-14T15:06:24.414Z",
"created_by": "97e6b22c9a4143789ca522df7457a32f",
"disk_config": "MANUAL",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"is_marketplace": false,
"keypair_name": "keypairname",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"locked": false,
"metadata": "",
"modified_at": "2026-04-14T15:06:24.414Z",
"name": "servername",
"partition_number": 1,
"planned_compute_os_type": "windows",
"product_category": "compute",
"product_offering": "virtual_server",
"security_groups": [
{
"name": "securitygroup"
}
],
"server_group_id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"server_type": {
"disk": 100,
"ephemeral": 0,
"extra_specs": "",
"id": "s1v1m2",
"name": "s1v1m2",
"ram": 2,
"swap": 0,
"vcpus": 1
},
"state": "ACTIVE",
"volumes": [
{
"delete_on_termination": false,
"id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
],
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
]
}
4.1.65.3 - 1.0
get /v1/servers
Description
List Virtual Servers.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | name optional | Server name Example : servername | any of [string, null] | None |
| query | ip optional | IP address Example : 192.169.3.2 | any of [string, null] | None |
| query | state optional | Server state Example : ACTIVE | any of [string, null] | None |
| query | product_category optional | Product category Example : compute | any of [enum (compute, container), null] | None |
| query | product_offering optional | Product offering Example : virtual_server | any of [array[enum (virtual_server, gpu_server, k8s_vm, k8s_gpu_vm)], enum (virtual_server, gpu_server, k8s_vm, k8s_gpu_vm), null] | None |
| query | vpc_id optional | VPC ID Example : cc976b621087484ea5fd527f4b78708b | any of [string, null] | None |
| query | server_type_id optional | Server type ID Example : s1v1m2 | any of [string, null] | None |
| query | limit optional | Page size of items Example : 20 | any of [integer, null] | None |
| query | marker optional | The last item’s ID from previous request Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | any of [string, null] | None |
| query | sort optional | Comma-separated list of sort keys and optional sort directions in the form of Example : created_at:desc | any of [string, null] | created_at:desc |
| query | auto_scaling_group_id optional | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/servers
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"servers": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"addresses": [
{
"ip_addresses": [
{
"ip_address": "192.169.3.2",
"version": 4
}
],
"subnet_name": "subnetname"
}
],
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2026-04-14T15:06:21.878Z",
"created_by": "97e6b22c9a4143789ca522df7457a32f",
"disk_config": "MANUAL",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"is_marketplace": false,
"keypair_name": "keypairname",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"locked": false,
"metadata": "",
"modified_at": "2026-04-14T15:06:21.878Z",
"name": "servername",
"partition_number": 1,
"planned_compute_os_type": "windows",
"product_category": "compute",
"product_offering": "virtual_server",
"security_groups": [
{
"name": "securitygroup"
}
],
"server_group_id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"server_type": {
"disk": 100,
"ephemeral": 0,
"extra_specs": "",
"id": "s1v1m2",
"name": "s1v1m2",
"ram": 2,
"swap": 0,
"vcpus": 1
},
"state": "ACTIVE",
"volumes": [
{
"delete_on_termination": false,
"id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
],
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
]
}
4.1.66 - List volume transfers
4.1.66.1 - 1.2
get /v1/volume-transfer
Description
List volume transfers.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VolumeTransferListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/volume-transfer
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"transfers": [
{
"id": "1ac231be-823b-4a4d-8ff0-aac503a7118a",
"name": "volume01",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
]
}
4.1.66.2 - 1.1
get /v1/volume-transfer
Description
List volume transfers.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VolumeTransferListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/volume-transfer
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"transfers": [
{
"id": "1ac231be-823b-4a4d-8ff0-aac503a7118a",
"name": "volume01",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
]
}
4.1.66.3 - 1.0
get /v1/volume-transfer
Description
List volume transfers.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VolumeTransferListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/volume-transfer
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"transfers": [
{
"id": "1ac231be-823b-4a4d-8ff0-aac503a7118a",
"name": "volume01",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
]
}
4.1.67 - List volume types
4.1.67.1 - 1.2
get /v1/volume-types
Description
List volume types.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | limit optional | Page size of items. Max value is 1000. Example : 20 | any of [integer, null] | 20 |
| query | offset optional | Index of where to start in the list Example : 0 | any of [integer, null] | None |
| query | marker optional | The last item’s ID from previous request Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | any of [string, null] | None |
| query | sort optional | Comma-separated list of sort keys and optional sort directions in the form of Example : created_at:desc | any of [string, null] | name:asc |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VolumeTypeListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 500 | Internal Server Error | None |
Example HTTP request
Request path
/v1/volume-types
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"volume_types": [
{
"description": "Volume type description",
"extra_specs": {
"multiattach": "<is> True"
},
"id": "c643ac35-3aec-43e6-b97a-3d6f666c5207",
"name": "SSD"
}
]
}
4.1.67.2 - 1.1
get /v1/volume-types
Description
List volume types.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | limit optional | Page size of items. Max value is 1000. Example : 20 | any of [integer, null] | 20 |
| query | offset optional | Index of where to start in the list Example : 0 | any of [integer, null] | None |
| query | marker optional | The last item’s ID from previous request Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | any of [string, null] | None |
| query | sort optional | Comma-separated list of sort keys and optional sort directions in the form of Example : created_at:desc | any of [string, null] | name:asc |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VolumeTypeListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 500 | Internal Server Error | None |
Example HTTP request
Request path
/v1/volume-types
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"volume_types": [
{
"description": "Volume type description",
"extra_specs": {
"multiattach": "<is> True"
},
"id": "c643ac35-3aec-43e6-b97a-3d6f666c5207",
"name": "SSD"
}
]
}
4.1.67.3 - 1.0
get /v1/volume-types
Description
List volume types.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | limit optional | Page size of items. Max value is 1000. Example : 20 | any of [integer, null] | 20 |
| query | offset optional | Index of where to start in the list Example : 0 | any of [integer, null] | None |
| query | marker optional | The last item’s ID from previous request Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | any of [string, null] | None |
| query | sort optional | Comma-separated list of sort keys and optional sort directions in the form of Example : created_at:desc | any of [string, null] | name:asc |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VolumeTypeListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 500 | Internal Server Error | None |
Example HTTP request
Request path
/v1/volume-types
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"volume_types": [
{
"description": "Volume type description",
"extra_specs": {
"multiattach": "<is> True"
},
"id": "c643ac35-3aec-43e6-b97a-3d6f666c5207",
"name": "SSD"
}
]
}
4.1.68 - List volumes
4.1.68.1 - 1.2
get /v1/volumes
Description
List volumes.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | with_count optional | Whether to show count Example : True | any of [boolean, null] | True |
| query | limit optional | Page size of items. Max value is 1000. Example : 20 | any of [integer, null] | 20 |
| query | marker optional | The last item’s ID from previous request Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | any of [string, null] | None |
| query | sort optional | Comma-separated list of sort keys and optional sort directions in the form of Example : created_at:desc | any of [string, null] | None |
| query | offset optional | Index of where to start in the list Example : 0 | any of [integer, null] | None |
| query | name optional | Volume name Example : volume01 | any of [string, null] | None |
| query | state optional | Volume state Example : available | any of [string, null] | None |
| query | bootable optional | Bootable Example : False | any of [boolean, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VolumeListResponseV1Dot2 |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/volumes
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"count": 100,
"volumes": [
{
"bootable": false,
"created_at": "2026-04-14T15:06:27.979Z",
"encrypted": true,
"id": "3f500f00-ed80-4566-a057-e31760226f9a",
"max_iops": 10000,
"max_throughput": 500,
"modified_at": "2025-07-26T12:00:00Z",
"multiattach": false,
"name": "volume01",
"servers": [
{
"attached_at": "2026-04-14T15:06:27.979Z",
"device": "/dev/vda",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
}
],
"size": 104,
"snapshot_id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"state": "available",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_image_metadata": {
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"disk_format": "qcow2",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"min_disk": 100,
"min_ram": 0,
"os_distro": "alma",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"signature_verified": false,
"size": 2429747200
},
"volume_type": "SSD",
"volume_type_id": "c643ac35-3aec-43e6-b97a-3d6f666c5207"
}
]
}
4.1.68.2 - 1.1
get /v1/volumes
Description
List volumes.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | with_count optional | Whether to show count Example : True | any of [boolean, null] | True |
| query | limit optional | Page size of items. Max value is 1000. Example : 20 | any of [integer, null] | 20 |
| query | marker optional | The last item’s ID from previous request Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | any of [string, null] | None |
| query | sort optional | Comma-separated list of sort keys and optional sort directions in the form of Example : created_at:desc | any of [string, null] | None |
| query | offset optional | Index of where to start in the list Example : 0 | any of [integer, null] | None |
| query | name optional | Volume name Example : volume01 | any of [string, null] | None |
| query | state optional | Volume state Example : available | any of [string, null] | None |
| query | bootable optional | Bootable Example : False | any of [boolean, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VolumeListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/volumes
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"count": 100,
"volumes": [
{
"bootable": false,
"created_at": "2026-04-14T15:06:25.481Z",
"encrypted": true,
"id": "3f500f00-ed80-4566-a057-e31760226f9a",
"modified_at": "2025-07-26T12:00:00Z",
"multiattach": false,
"name": "volume01",
"servers": [
{
"attached_at": "2026-04-14T15:06:25.481Z",
"device": "/dev/vda",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
}
],
"size": 104,
"snapshot_id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"state": "available",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_image_metadata": {
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"disk_format": "qcow2",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"min_disk": 100,
"min_ram": 0,
"os_distro": "alma",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"signature_verified": false,
"size": 2429747200
},
"volume_type": "SSD",
"volume_type_id": "c643ac35-3aec-43e6-b97a-3d6f666c5207"
}
]
}
4.1.68.3 - 1.0
get /v1/volumes
Description
List volumes.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | with_count optional | Whether to show count Example : True | any of [boolean, null] | True |
| query | limit optional | Page size of items. Max value is 1000. Example : 20 | any of [integer, null] | 20 |
| query | marker optional | The last item’s ID from previous request Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | any of [string, null] | None |
| query | sort optional | Comma-separated list of sort keys and optional sort directions in the form of Example : created_at:desc | any of [string, null] | None |
| query | offset optional | Index of where to start in the list Example : 0 | any of [integer, null] | None |
| query | name optional | Volume name Example : volume01 | any of [string, null] | None |
| query | state optional | Volume state Example : available | any of [string, null] | None |
| query | bootable optional | Bootable Example : False | any of [boolean, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VolumeListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/volumes
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"count": 100,
"volumes": [
{
"bootable": false,
"created_at": "2026-04-14T15:06:22.983Z",
"encrypted": true,
"id": "3f500f00-ed80-4566-a057-e31760226f9a",
"modified_at": "2025-07-26T12:00:00Z",
"multiattach": false,
"name": "volume01",
"servers": [
{
"attached_at": "2026-04-14T15:06:22.983Z",
"device": "/dev/vda",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
}
],
"size": 104,
"snapshot_id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"state": "available",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_image_metadata": {
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"disk_format": "qcow2",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"min_disk": 100,
"min_ram": 0,
"os_distro": "alma",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"signature_verified": false,
"size": 2429747200
},
"volume_type": "SSD",
"volume_type_id": "c643ac35-3aec-43e6-b97a-3d6f666c5207"
}
]
}
4.1.69 - Lock Virtual Server
4.1.69.1 - 1.2
post /v1/servers/{server_id}/lock
Description
Lock Virtual Server.
The lock prevents actions such as terminate/start/stop the server from being executed, preventing accidental actions.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/lock
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 202
4.1.69.2 - 1.1
post /v1/servers/{server_id}/lock
Description
Lock Virtual Server.
The lock prevents actions such as terminate/start/stop the server from being executed, preventing accidental actions.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/lock
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 202
4.1.69.3 - 1.0
post /v1/servers/{server_id}/lock
Description
Lock Virtual Server.
The lock prevents actions such as terminate/start/stop the server from being executed, preventing accidental actions.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/lock
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 202
4.1.70 - Reboot Virtual Server
4.1.70.1 - 1.2
post /v1/servers/{server_id}/reboot
Description
Reboot Virtual Server.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| body | body required | ServerRebootRequestBody |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/reboot
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"reboot_type": "SOFT"
}
Example HTTP response
Response 202
4.1.70.2 - 1.1
post /v1/servers/{server_id}/reboot
Description
Reboot Virtual Server.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| body | body required | ServerRebootRequestBody |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/reboot
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"reboot_type": "SOFT"
}
Example HTTP response
Response 202
4.1.70.3 - 1.0
post /v1/servers/{server_id}/reboot
Description
Reboot Virtual Server.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| body | body required | ServerRebootRequestBody |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/reboot
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"reboot_type": "SOFT"
}
Example HTTP response
Response 202
4.1.71 - Rebuild Virtual Server
4.1.71.1 - 1.2
post /v1/servers/{server_id}/rebuild
Description
Rebuild Virtual Server.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/rebuild
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 202
4.1.71.2 - 1.1
post /v1/servers/{server_id}/rebuild
Description
Rebuild Virtual Server.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/rebuild
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 202
4.1.71.3 - 1.0
post /v1/servers/{server_id}/rebuild
Description
Rebuild Virtual Server.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/rebuild
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 202
4.1.72 - Revert Volume to snapshot
4.1.72.1 - 1.2
post /v1/volumes/{volume_id}/revert
Description
Revert a volume to its latest snapshot, this API only support reverting a detached volume, and the volume status must be available.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | volume_id required | Volume ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string | None |
| body | body required | VolumeRevertRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/volumes/{volume_id}/revert
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"snapshot_id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790"
}
Example HTTP response
Response 202
4.1.72.2 - 1.1
post /v1/volumes/{volume_id}/revert
Description
Revert a volume to its latest snapshot, this API only support reverting a detached volume, and the volume status must be available.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | volume_id required | Volume ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string | None |
| body | body required | VolumeRevertRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/volumes/{volume_id}/revert
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"snapshot_id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790"
}
Example HTTP response
Response 202
4.1.72.3 - 1.0
post /v1/volumes/{volume_id}/revert
Description
Revert a volume to its latest snapshot, this API only support reverting a detached volume, and the volume status must be available.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | volume_id required | Volume ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string | None |
| body | body required | VolumeRevertRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/volumes/{volume_id}/revert
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"snapshot_id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790"
}
Example HTTP response
Response 202
4.1.73 - Set Volume Qos
4.1.73.1 - 1.2
put /v1/volumes/{volume_id}/qos
Description
Set Volume Qos
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | volume_id required | Volume ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string | None |
| body | body required | VolumeSetQosRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/volumes/{volume_id}/qos
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"max_iops": 10000,
"max_throughput": 500
}
Example HTTP response
Response 202
4.1.74 - Show a snapshot’s details
4.1.74.1 - 1.2
get /v1/snapshots/{snapshot_id}
Description
Show a snapshot’s details.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | snapshot_id required | Snapshot ID Example : cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SnapshotDetailResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/snapshots/{snapshot_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"created_at": "2025-07-22T09:00:00Z",
"description": "description",
"id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"metadata": "Metadata",
"name": "snapshot-1",
"size": 104,
"status": "available",
"updated_at": "2025-07-26T12:00:00Z",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
4.1.74.2 - 1.1
get /v1/snapshots/{snapshot_id}
Description
Show a snapshot’s details.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | snapshot_id required | Snapshot ID Example : cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SnapshotDetailResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/snapshots/{snapshot_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"created_at": "2025-07-22T09:00:00Z",
"description": "description",
"id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"metadata": "Metadata",
"name": "snapshot-1",
"size": 104,
"status": "available",
"updated_at": "2025-07-26T12:00:00Z",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
4.1.74.3 - 1.0
get /v1/snapshots/{snapshot_id}
Description
Show a snapshot’s details.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | snapshot_id required | Snapshot ID Example : cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SnapshotDetailResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/snapshots/{snapshot_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"created_at": "2025-07-22T09:00:00Z",
"description": "description",
"id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"metadata": "Metadata",
"name": "snapshot-1",
"size": 104,
"status": "available",
"updated_at": "2025-07-26T12:00:00Z",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
4.1.75 - Show Auto-Scaling Group
4.1.75.1 - 1.2
get /v1/auto-scaling-groups/{auto_scaling_group_id}
Description
Show Auto-Scaling Group.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupShowResponseV1Dot2 |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"desired_server_count": 1,
"desired_server_count_editable": true,
"drain_enabled": true,
"drain_timeout": 300,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"launch_configuration_name": "launch-configuration-name",
"lb_server_groups": [],
"max_server_count": 2,
"min_server_count": 1,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "auto-scaling-group-name",
"security_group_ids": [
"c09c3f05-03d9-443f-b27a-40e0f973c75f"
],
"server_name_prefix": "server-name-prefix",
"state": "IN_SERVICE",
"state_check_delay_time": 300,
"subnet_ids": [],
"total_server_count": 1,
"use_lb_state_check": true,
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
4.1.75.2 - 1.1
get /v1/auto-scaling-groups/{auto_scaling_group_id}
Description
Show Auto-Scaling Group.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupShowResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"desired_server_count": 1,
"desired_server_count_editable": true,
"drain_enabled": true,
"drain_timeout": 300,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"launch_configuration_name": "launch-configuration-name",
"lb_server_groups": [],
"max_server_count": 2,
"min_server_count": 1,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "auto-scaling-group-name",
"security_group_ids": [
"c09c3f05-03d9-443f-b27a-40e0f973c75f"
],
"server_name_prefix": "server-name-prefix",
"state": "IN_SERVICE",
"subnet_ids": [],
"total_server_count": 1,
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
4.1.75.3 - 1.0
get /v1/auto-scaling-groups/{auto_scaling_group_id}
Description
Show Auto-Scaling Group.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupShowResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"desired_server_count": 1,
"desired_server_count_editable": true,
"drain_enabled": true,
"drain_timeout": 300,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"launch_configuration_name": "launch-configuration-name",
"lb_server_groups": [],
"max_server_count": 2,
"min_server_count": 1,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "auto-scaling-group-name",
"security_group_ids": [
"c09c3f05-03d9-443f-b27a-40e0f973c75f"
],
"server_name_prefix": "server-name-prefix",
"state": "IN_SERVICE",
"subnet_ids": [],
"total_server_count": 1,
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
4.1.76 - Show Auto-Scaling Group Notification
4.1.76.1 - 1.2
get /v1/auto-scaling-groups/{auto_scaling_group_id}/notifications/{notification_id}
Description
Show Auto-Scaling Group notification.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| path | notification_id required | Auto-Scaling Group notification ID Example : fa7fd191410744cd810a290c0b4d22b9 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupNotificationShowResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/notifications/{notification_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"notification_events": [
"SCALE_OUT",
"SCALE_OUT_FAIL"
],
"notification_state": "ACTIVE",
"user_email": "scpuser@samsung.com",
"user_id": "570907805e5447be84b618450ef52o0t",
"user_name": "scpuser"
}
4.1.76.2 - 1.1
get /v1/auto-scaling-groups/{auto_scaling_group_id}/notifications/{notification_id}
Description
Show Auto-Scaling Group notification.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| path | notification_id required | Auto-Scaling Group notification ID Example : fa7fd191410744cd810a290c0b4d22b9 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupNotificationShowResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/notifications/{notification_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"notification_events": [
"SCALE_OUT",
"SCALE_OUT_FAIL"
],
"notification_state": "ACTIVE",
"user_email": "scpuser@samsung.com",
"user_id": "570907805e5447be84b618450ef52o0t",
"user_name": "scpuser"
}
4.1.76.3 - 1.0
get /v1/auto-scaling-groups/{auto_scaling_group_id}/notifications/{notification_id}
Description
Show Auto-Scaling Group notification.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| path | notification_id required | Auto-Scaling Group notification ID Example : fa7fd191410744cd810a290c0b4d22b9 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupNotificationShowResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/notifications/{notification_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"notification_events": [
"SCALE_OUT",
"SCALE_OUT_FAIL"
],
"notification_state": "ACTIVE",
"user_email": "scpuser@samsung.com",
"user_id": "570907805e5447be84b618450ef52o0t",
"user_name": "scpuser"
}
4.1.77 - Show Auto-Scaling Group Policy
4.1.77.1 - 1.2
get /v1/auto-scaling-groups/{auto_scaling_group_id}/policies/{policy_id}
Description
Show Auto-Scaling Group policy.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| path | policy_id required | Policy ID Example : 0761d76085f54363bab07909baf69841 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupPolicyShowResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/policies/{policy_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"comparison_operator": "ge",
"cooldown_seconds": 300,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"evaluation_minutes": 5,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"metric_method": "AVG",
"metric_type": "CPU",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "policy-name",
"scale_method": "AMOUNT",
"scale_type": "SCALE_OUT",
"scale_value": 10,
"state": "ACTIVE",
"threshold": 60,
"threshold_unit": "%"
}
4.1.77.2 - 1.1
get /v1/auto-scaling-groups/{auto_scaling_group_id}/policies/{policy_id}
Description
Show Auto-Scaling Group policy.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| path | policy_id required | Policy ID Example : 0761d76085f54363bab07909baf69841 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupPolicyShowResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/policies/{policy_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"comparison_operator": "ge",
"cooldown_seconds": 300,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"evaluation_minutes": 5,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"metric_method": "AVG",
"metric_type": "CPU",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "policy-name",
"scale_method": "AMOUNT",
"scale_type": "SCALE_OUT",
"scale_value": 10,
"state": "ACTIVE",
"threshold": 60,
"threshold_unit": "%"
}
4.1.77.3 - 1.0
get /v1/auto-scaling-groups/{auto_scaling_group_id}/policies/{policy_id}
Description
Show Auto-Scaling Group policy.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| path | policy_id required | Policy ID Example : 0761d76085f54363bab07909baf69841 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupPolicyShowResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/policies/{policy_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"comparison_operator": "ge",
"cooldown_seconds": 300,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"evaluation_minutes": 5,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"metric_method": "AVG",
"metric_type": "CPU",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "policy-name",
"scale_method": "AMOUNT",
"scale_type": "SCALE_OUT",
"scale_value": 10,
"state": "ACTIVE",
"threshold": 60,
"threshold_unit": "%"
}
4.1.78 - Show Auto-Scaling Group Schedule
4.1.78.1 - 1.2
get /v1/auto-scaling-groups/{auto_scaling_group_id}/schedules/{schedule_id}
Description
Show Auto-Scaling Group schedule.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| path | schedule_id required | Schedule ID Example : 43d4841abd404220af5f0904037aba71 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupScheduleShowResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/schedules/{schedule_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"day_of_month": "-1,1",
"day_of_week": "SU,SA",
"description": "description",
"desired_server_count": 1,
"end_date": "2025-01-01",
"frequency": "WEEKLY",
"hour": 9,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"max_server_count": 2,
"min_server_count": 1,
"minute": 0,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "schedulename",
"start_date": "2024-01-01",
"state": "ACTIVE",
"timezone": "Asia/Seoul"
}
4.1.78.2 - 1.1
get /v1/auto-scaling-groups/{auto_scaling_group_id}/schedules/{schedule_id}
Description
Show Auto-Scaling Group schedule.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| path | schedule_id required | Schedule ID Example : 43d4841abd404220af5f0904037aba71 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupScheduleShowResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/schedules/{schedule_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"day_of_month": "-1,1",
"day_of_week": "SU,SA",
"description": "description",
"desired_server_count": 1,
"end_date": "2025-01-01",
"frequency": "WEEKLY",
"hour": 9,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"max_server_count": 2,
"min_server_count": 1,
"minute": 0,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "schedulename",
"start_date": "2024-01-01",
"state": "ACTIVE",
"timezone": "Asia/Seoul"
}
4.1.78.3 - 1.0
get /v1/auto-scaling-groups/{auto_scaling_group_id}/schedules/{schedule_id}
Description
Show Auto-Scaling Group schedule.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| path | schedule_id required | Schedule ID Example : 43d4841abd404220af5f0904037aba71 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupScheduleShowResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/schedules/{schedule_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"day_of_month": "-1,1",
"day_of_week": "SU,SA",
"description": "description",
"desired_server_count": 1,
"end_date": "2025-01-01",
"frequency": "WEEKLY",
"hour": 9,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"max_server_count": 2,
"min_server_count": 1,
"minute": 0,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "schedulename",
"start_date": "2024-01-01",
"state": "ACTIVE",
"timezone": "Asia/Seoul"
}
4.1.79 - Show default Volume type’s details
4.1.79.1 - 1.2
get /v1/volume-types/default
Description
Show a default Volume type’s details.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VolumeTypeDetailResponse |
| 401 | Unauthorized | None |
| 500 | Internal Server Error | None |
Example HTTP request
Request path
/v1/volume-types/default
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"description": "Volume type description",
"extra_specs": {
"multiattach": "<is> True"
},
"id": "c643ac35-3aec-43e6-b97a-3d6f666c5207",
"name": "SSD"
}
4.1.79.2 - 1.1
get /v1/volume-types/default
Description
Show a default Volume type’s details.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VolumeTypeDetailResponse |
| 401 | Unauthorized | None |
| 500 | Internal Server Error | None |
Example HTTP request
Request path
/v1/volume-types/default
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"description": "Volume type description",
"extra_specs": {
"multiattach": "<is> True"
},
"id": "c643ac35-3aec-43e6-b97a-3d6f666c5207",
"name": "SSD"
}
4.1.79.3 - 1.0
get /v1/volume-types/default
Description
Show a default Volume type’s details.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VolumeTypeDetailResponse |
| 401 | Unauthorized | None |
| 500 | Internal Server Error | None |
Example HTTP request
Request path
/v1/volume-types/default
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"description": "Volume type description",
"extra_specs": {
"multiattach": "<is> True"
},
"id": "c643ac35-3aec-43e6-b97a-3d6f666c5207",
"name": "SSD"
}
4.1.80 - Show Image
4.1.80.1 - 1.2
get /v1/images/{image_id}
Description
Show Image.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | image_id required | Image ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ImageShowResponseV1Dot2 |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/images/{image_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"created_at": "2025-07-22T09:00:00Z",
"disk_format": "qcow2",
"file": "/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file",
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"min_disk": 100,
"min_ram": 0,
"name": "imagename",
"os_distro": "alma",
"os_hash_algo": "sha512",
"os_hash_value": "c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99",
"os_hidden": false,
"owner": "a8f10467abfc4b87b64614ab36eb9ae4",
"owner_account_name": "AccountName",
"owner_user_name": "user@samsung.com",
"protected": false,
"root_device_name": "/dev/vda",
"scp_gpu_driver": "535.183.06",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"scp_os_build_version": "20250101",
"scp_os_version": "8.8",
"size": 2429747200,
"status": "active",
"updated_at": "2025-07-26T12:00:00Z",
"url": "https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2",
"virtual_size": 17179869184,
"visibility": "private",
"volumes": "[{\"tag\": null, \"volume_id\": null, \"encryption_options\": null, \"encryption_secret_uuid\": null, \"encryption_format\": null, \"device_name\": \"/dev/vda\", \"disk_bus\": \"virtio\", \"volume_type\": null, \"encrypted\": null, \"image_id\": null, \"device_type\": \"disk\", \"source_type\": \"snapshot\", \"delete_on_termination\": false, \"volume_size\": 104, \"guest_format\": null, \"boot_index\": 0, \"destination_type\": \"volume\", \"snapshot_id\": \"abde9e38-2ed5-4ecd-b23c-b0120e30690e\", \"no_device\": null}]"
}
4.1.80.2 - 1.1
get /v1/images/{image_id}
Description
Show Image.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | image_id required | Image ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ImageShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/images/{image_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"created_at": "2025-07-22T09:00:00Z",
"disk_format": "qcow2",
"file": "/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file",
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"min_disk": 100,
"min_ram": 0,
"name": "imagename",
"os_distro": "alma",
"os_hash_algo": "sha512",
"os_hash_value": "c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99",
"os_hidden": false,
"owner": "a8f10467abfc4b87b64614ab36eb9ae4",
"owner_account_name": "AccountName",
"owner_user_name": "user@samsung.com",
"protected": false,
"root_device_name": "/dev/vda",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"scp_os_build_version": "20250101",
"scp_os_version": "8.8",
"size": 2429747200,
"status": "active",
"updated_at": "2025-07-26T12:00:00Z",
"url": "https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2",
"virtual_size": 17179869184,
"visibility": "private",
"volumes": "[{\"tag\": null, \"volume_id\": null, \"encryption_options\": null, \"encryption_secret_uuid\": null, \"encryption_format\": null, \"device_name\": \"/dev/vda\", \"disk_bus\": \"virtio\", \"volume_type\": null, \"encrypted\": null, \"image_id\": null, \"device_type\": \"disk\", \"source_type\": \"snapshot\", \"delete_on_termination\": false, \"volume_size\": 104, \"guest_format\": null, \"boot_index\": 0, \"destination_type\": \"volume\", \"snapshot_id\": \"abde9e38-2ed5-4ecd-b23c-b0120e30690e\", \"no_device\": null}]"
}
4.1.80.3 - 1.0
get /v1/images/{image_id}
Description
Show Image.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | image_id required | Image ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ImageShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/images/{image_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"created_at": "2025-07-22T09:00:00Z",
"disk_format": "qcow2",
"file": "/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file",
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"min_disk": 100,
"min_ram": 0,
"name": "imagename",
"os_distro": "alma",
"os_hash_algo": "sha512",
"os_hash_value": "c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99",
"os_hidden": false,
"owner": "a8f10467abfc4b87b64614ab36eb9ae4",
"owner_account_name": "AccountName",
"owner_user_name": "user@samsung.com",
"protected": false,
"root_device_name": "/dev/vda",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"scp_os_build_version": "20250101",
"scp_os_version": "8.8",
"size": 2429747200,
"status": "active",
"updated_at": "2025-07-26T12:00:00Z",
"url": "https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2",
"virtual_size": 17179869184,
"visibility": "private",
"volumes": "[{\"tag\": null, \"volume_id\": null, \"encryption_options\": null, \"encryption_secret_uuid\": null, \"encryption_format\": null, \"device_name\": \"/dev/vda\", \"disk_bus\": \"virtio\", \"volume_type\": null, \"encrypted\": null, \"image_id\": null, \"device_type\": \"disk\", \"source_type\": \"snapshot\", \"delete_on_termination\": false, \"volume_size\": 104, \"guest_format\": null, \"boot_index\": 0, \"destination_type\": \"volume\", \"snapshot_id\": \"abde9e38-2ed5-4ecd-b23c-b0120e30690e\", \"no_device\": null}]"
}
4.1.81 - Show Image member
4.1.81.1 - 1.2
get /v1/images/{image_id}/members/{member_id}
Description
Show Image member.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | image_id required | Image ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | None |
| path | member_id required | Shared Image member ID Example : a8f10467abfc4b87b64614ab36eb9ae4 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ImageMemberShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/images/{image_id}/members/{member_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"created_at": "2025-07-22T09:00:00Z",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"member_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"status": "pending",
"updated_at": "2025-07-26T12:00:00Z"
}
4.1.81.2 - 1.1
get /v1/images/{image_id}/members/{member_id}
Description
Show Image member.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | image_id required | Image ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | None |
| path | member_id required | Shared Image member ID Example : a8f10467abfc4b87b64614ab36eb9ae4 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ImageMemberShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/images/{image_id}/members/{member_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"created_at": "2025-07-22T09:00:00Z",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"member_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"status": "pending",
"updated_at": "2025-07-26T12:00:00Z"
}
4.1.81.3 - 1.0
get /v1/images/{image_id}/members/{member_id}
Description
Show Image member.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | image_id required | Image ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | None |
| path | member_id required | Shared Image member ID Example : a8f10467abfc4b87b64614ab36eb9ae4 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ImageMemberShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/images/{image_id}/members/{member_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"created_at": "2025-07-22T09:00:00Z",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"member_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"status": "pending",
"updated_at": "2025-07-26T12:00:00Z"
}
4.1.82 - Show Keypair
4.1.82.1 - 1.2
get /v1/keypairs/{keypair_name}
Description
Show keypair.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | keypair_name required | Keypair name Example : keypairname | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | KeypairShowResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/keypairs/{keypair_name}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"created_at": "2025-07-22T09:00:00Z",
"fingerprint": "7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd",
"id": 1,
"name": "keypairname",
"public_key": "ssh-rsa fakeKey Generated-by-SCP",
"type": "ssh",
"user_id": "570907805e5447be84b618450ef52o0t"
}
4.1.82.2 - 1.1
get /v1/keypairs/{keypair_name}
Description
Show keypair.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | keypair_name required | Keypair name Example : keypairname | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | KeypairShowResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/keypairs/{keypair_name}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"created_at": "2025-07-22T09:00:00Z",
"fingerprint": "7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd",
"id": 1,
"name": "keypairname",
"public_key": "ssh-rsa fakeKey Generated-by-SCP",
"type": "ssh",
"user_id": "570907805e5447be84b618450ef52o0t"
}
4.1.82.3 - 1.0
get /v1/keypairs/{keypair_name}
Description
Show keypair.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | keypair_name required | Keypair name Example : keypairname | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | KeypairShowResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/keypairs/{keypair_name}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"created_at": "2025-07-22T09:00:00Z",
"fingerprint": "7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd",
"id": 1,
"name": "keypairname",
"public_key": "ssh-rsa fakeKey Generated-by-SCP",
"type": "ssh",
"user_id": "570907805e5447be84b618450ef52o0t"
}
4.1.83 - Show Launch Configuration
4.1.83.1 - 1.2
get /v1/launch-configurations/{launch_configuration_id}
Description
Show Launch Configuration.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | launch_configuration_id required | Launch Configuration ID Example : b5aea5a675fc4f6b9e0fcd1288354c5f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | LaunchConfigurationDetailShowResponseV1Dot2 |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/launch-configurations/{launch_configuration_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_count": 1,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"file_storage_ids": [
""
],
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"keypair_name": "keypairname",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "launch-configuration-name",
"public_key": "ssh-rsa fakeKey Generated-by-SCP",
"server_type_id": "s1v1m2",
"state": "ACTIVE",
"user_data": "IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==",
"volumes": [
{
"boot_index": 0,
"max_iops": 10000,
"max_throughput": 500,
"size": 104,
"type": "SSD"
}
]
}
4.1.83.2 - 1.1
get /v1/launch-configurations/{launch_configuration_id}
Description
Show Launch Configuration.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | launch_configuration_id required | Launch Configuration ID Example : b5aea5a675fc4f6b9e0fcd1288354c5f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | LaunchConfigurationDetailShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/launch-configurations/{launch_configuration_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_count": 1,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"keypair_name": "keypairname",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "launch-configuration-name",
"public_key": "ssh-rsa fakeKey Generated-by-SCP",
"server_type_id": "s1v1m2",
"state": "ACTIVE",
"user_data": "IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==",
"volumes": [
{
"boot_index": 0,
"size": 104,
"type": "SSD"
}
]
}
4.1.83.3 - 1.0
get /v1/launch-configurations/{launch_configuration_id}
Description
Show Launch Configuration.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | launch_configuration_id required | Launch Configuration ID Example : b5aea5a675fc4f6b9e0fcd1288354c5f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | LaunchConfigurationDetailShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/launch-configurations/{launch_configuration_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_count": 1,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"keypair_name": "keypairname",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "launch-configuration-name",
"public_key": "ssh-rsa fakeKey Generated-by-SCP",
"server_type_id": "s1v1m2",
"state": "ACTIVE",
"user_data": "IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==",
"volumes": [
{
"boot_index": 0,
"size": 104,
"type": "SSD"
}
]
}
4.1.84 - Show Server Group
4.1.84.1 - 1.2
get /v1/server-groups/{server_group_id}
Description
Show server group.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_group_id required | Server Group ID Example : 616fb98f-46ca-475e-917e-2563e5a8cd19 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerGroup |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/server-groups/{server_group_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"members": [
"2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
],
"name": "server-group",
"partition_size": 3,
"policy": "anti-affinity",
"user_id": "570907805e5447be84b618450ef52o0t"
}
4.1.84.2 - 1.1
get /v1/server-groups/{server_group_id}
Description
Show server group.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_group_id required | Server Group ID Example : 616fb98f-46ca-475e-917e-2563e5a8cd19 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerGroup |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/server-groups/{server_group_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"members": [
"2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
],
"name": "server-group",
"partition_size": 3,
"policy": "anti-affinity",
"user_id": "570907805e5447be84b618450ef52o0t"
}
4.1.84.3 - 1.0
get /v1/server-groups/{server_group_id}
Description
Show server group.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_group_id required | Server Group ID Example : 616fb98f-46ca-475e-917e-2563e5a8cd19 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerGroup |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/server-groups/{server_group_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"members": [
"2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
],
"name": "server-group",
"partition_size": 3,
"policy": "anti-affinity",
"user_id": "570907805e5447be84b618450ef52o0t"
}
4.1.85 - Show Server Interface
4.1.85.1 - 1.2
get /v1/servers/{server_id}/interfaces/{port_id}
Description
Show Server Interface.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| path | port_id required | Port ID Example : 91424c08-0b26-49fb-9808-ed042292ceef | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerInterfaceListResponseV1Dot2 |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces/{port_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"interfaces": [
{
"fixed_ips": [
{
"ip_address": "192.169.3.2"
}
],
"is_default": true,
"mac_addr": "fa:16:3e:c0:71:2b",
"port_id": "f2b02fc5-a5fd-4b5f-b1a9-987f4c0d66cc",
"port_state": "ACTIVE",
"private_static_nat": {
"external_ip_address": "182.197.61.81",
"id": "224b80106e6f41b38efe98ac9ddbf280",
"private_nat_ip_id": "1f0cb5390c40483592ddc5a282f53496",
"state": "ACTIVE"
},
"static_nat": {
"external_ip_address": "182.197.61.81",
"id": "224b80106e6f41b38efe98ac9ddbf280",
"publicip_id": "615fa9cd5cff486c9de679b3ce63e601",
"state": "ACTIVE"
},
"subnet_id": "183c6c30df0c4fcbb16422aa2d64aa21"
}
]
}
4.1.85.2 - 1.1
get /v1/servers/{server_id}/interfaces/{port_id}
Description
Show Server Interface.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| path | port_id required | Port ID Example : 91424c08-0b26-49fb-9808-ed042292ceef | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerInterfaceListResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces/{port_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"interfaces": [
{
"fixed_ips": [
{
"ip_address": "192.169.3.2"
}
],
"mac_addr": "fa:16:3e:c0:71:2b",
"port_id": "f2b02fc5-a5fd-4b5f-b1a9-987f4c0d66cc",
"port_state": "ACTIVE",
"private_static_nat": {
"external_ip_address": "182.197.61.81",
"id": "224b80106e6f41b38efe98ac9ddbf280",
"private_nat_ip_id": "1f0cb5390c40483592ddc5a282f53496",
"state": "ACTIVE"
},
"static_nat": {
"external_ip_address": "182.197.61.81",
"id": "224b80106e6f41b38efe98ac9ddbf280",
"publicip_id": "615fa9cd5cff486c9de679b3ce63e601",
"state": "ACTIVE"
},
"subnet_id": "183c6c30df0c4fcbb16422aa2d64aa21"
}
]
}
4.1.85.3 - 1.0
get /v1/servers/{server_id}/interfaces/{port_id}
Description
Show Server Interface.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| path | port_id required | Port ID Example : 91424c08-0b26-49fb-9808-ed042292ceef | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerInterfaceListResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces/{port_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"interfaces": [
{
"fixed_ips": [
{
"ip_address": "192.169.3.2"
}
],
"mac_addr": "fa:16:3e:c0:71:2b",
"port_id": "f2b02fc5-a5fd-4b5f-b1a9-987f4c0d66cc",
"port_state": "ACTIVE",
"private_static_nat": {
"external_ip_address": "182.197.61.81",
"id": "224b80106e6f41b38efe98ac9ddbf280",
"private_nat_ip_id": "1f0cb5390c40483592ddc5a282f53496",
"state": "ACTIVE"
},
"static_nat": {
"external_ip_address": "182.197.61.81",
"id": "224b80106e6f41b38efe98ac9ddbf280",
"publicip_id": "615fa9cd5cff486c9de679b3ce63e601",
"state": "ACTIVE"
},
"subnet_id": "183c6c30df0c4fcbb16422aa2d64aa21"
}
]
}
4.1.86 - Show Server Ip
4.1.86.1 - 1.2
get /v1/servers/{server_id}/ips/{subnet_id}
Description
Show Server Ip.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| path | subnet_id required | Subnet ID Example : 78b2ee3f074145c580ab6abac4821f97 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerShowResponseAddress |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/ips/{subnet_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"ip_addresses": [
{
"ip_address": "192.169.3.2",
"version": 4
}
],
"subnet_name": "subnetname"
}
4.1.86.2 - 1.1
get /v1/servers/{server_id}/ips/{subnet_id}
Description
Show Server Ip.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| path | subnet_id required | Subnet ID Example : 78b2ee3f074145c580ab6abac4821f97 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerShowResponseAddress |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/ips/{subnet_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"ip_addresses": [
{
"ip_address": "192.169.3.2",
"version": 4
}
],
"subnet_name": "subnetname"
}
4.1.86.3 - 1.0
get /v1/servers/{server_id}/ips/{subnet_id}
Description
Show Server Ip.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| path | subnet_id required | Subnet ID Example : 78b2ee3f074145c580ab6abac4821f97 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerShowResponseAddress |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/ips/{subnet_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"ip_addresses": [
{
"ip_address": "192.169.3.2",
"version": 4
}
],
"subnet_name": "subnetname"
}
4.1.87 - Show Server Quota Set
4.1.87.1 - 1.2
get /v1/quota-sets
Description
Show server quota Set.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerQuotaSet |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/quota-sets
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"cores": {
"in_use": 10,
"limit": 20,
"reserved": 0
},
"id": "fc7283354c6143a58629b59f4c3e16b2",
"instances": {
"in_use": 10,
"limit": 20,
"reserved": 0
},
"keypairs": {
"in_use": 10,
"limit": 20,
"reserved": 0
},
"metadata_items": {
"in_use": 10,
"limit": 20,
"reserved": 0
},
"ram": {
"in_use": 10,
"limit": 20,
"reserved": 0
},
"server_group_members": {
"in_use": 10,
"limit": 20,
"reserved": 0
},
"server_groups": {
"in_use": 10,
"limit": 20,
"reserved": 0
}
}
4.1.87.2 - 1.1
get /v1/quota-sets
Description
Show server quota Set.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerQuotaSet |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/quota-sets
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"cores": {
"in_use": 10,
"limit": 20,
"reserved": 0
},
"id": "fc7283354c6143a58629b59f4c3e16b2",
"instances": {
"in_use": 10,
"limit": 20,
"reserved": 0
},
"keypairs": {
"in_use": 10,
"limit": 20,
"reserved": 0
},
"metadata_items": {
"in_use": 10,
"limit": 20,
"reserved": 0
},
"ram": {
"in_use": 10,
"limit": 20,
"reserved": 0
},
"server_group_members": {
"in_use": 10,
"limit": 20,
"reserved": 0
},
"server_groups": {
"in_use": 10,
"limit": 20,
"reserved": 0
}
}
4.1.87.3 - 1.0
get /v1/quota-sets
Description
Show server quota Set.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerQuotaSet |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/quota-sets
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"cores": {
"in_use": 10,
"limit": 20,
"reserved": 0
},
"id": "fc7283354c6143a58629b59f4c3e16b2",
"instances": {
"in_use": 10,
"limit": 20,
"reserved": 0
},
"keypairs": {
"in_use": 10,
"limit": 20,
"reserved": 0
},
"metadata_items": {
"in_use": 10,
"limit": 20,
"reserved": 0
},
"ram": {
"in_use": 10,
"limit": 20,
"reserved": 0
},
"server_group_members": {
"in_use": 10,
"limit": 20,
"reserved": 0
},
"server_groups": {
"in_use": 10,
"limit": 20,
"reserved": 0
}
}
4.1.88 - Show Server Type
4.1.88.1 - 1.2
get /v1/server-types/{server_type_id}
Description
Show server type.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_type_id required | Server type ID Example : s1v1m2 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerType |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/server-types/{server_type_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"description": "description",
"disk": 100,
"ephemeral": 0,
"extra_specs": "",
"id": "s1v1m2",
"name": "s1v1m2",
"ram": 2,
"swap": 0,
"vcpus": 1
}
4.1.88.2 - 1.1
get /v1/server-types/{server_type_id}
Description
Show server type.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_type_id required | Server type ID Example : s1v1m2 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerType |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/server-types/{server_type_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"description": "description",
"disk": 100,
"ephemeral": 0,
"extra_specs": "",
"id": "s1v1m2",
"name": "s1v1m2",
"ram": 2,
"swap": 0,
"vcpus": 1
}
4.1.88.3 - 1.0
get /v1/server-types/{server_type_id}
Description
Show server type.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_type_id required | Server type ID Example : s1v1m2 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerType |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/server-types/{server_type_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"description": "description",
"disk": 100,
"ephemeral": 0,
"extra_specs": "",
"id": "s1v1m2",
"name": "s1v1m2",
"ram": 2,
"swap": 0,
"vcpus": 1
}
4.1.89 - Show Server Volume
4.1.89.1 - 1.2
get /v1/servers/{server_id}/volumes/{volume_id}
Description
Show Server Volume.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| path | volume_id required | Volume ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServersVolumeResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/volumes/{volume_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"delete_on_termination": false,
"device": "/dev/vda",
"id": "3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c",
"server_id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
4.1.89.2 - 1.1
get /v1/servers/{server_id}/volumes/{volume_id}
Description
Show Server Volume.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| path | volume_id required | Volume ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServersVolumeResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/volumes/{volume_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"delete_on_termination": false,
"device": "/dev/vda",
"id": "3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c",
"server_id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
4.1.89.3 - 1.0
get /v1/servers/{server_id}/volumes/{volume_id}
Description
Show Server Volume.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| path | volume_id required | Volume ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServersVolumeResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/volumes/{volume_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"delete_on_termination": false,
"device": "/dev/vda",
"id": "3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c",
"server_id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
4.1.90 - Show Virtual Server
4.1.90.1 - 1.2
get /v1/servers/{server_id}
Description
Show Virtual Server.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerShowResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"addresses": [
{
"ip_addresses": [
{
"ip_address": "192.169.3.2",
"version": 4
}
],
"subnet_name": "subnetname"
}
],
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2026-04-14T15:06:26.964Z",
"created_by": "97e6b22c9a4143789ca522df7457a32f",
"disk_config": "MANUAL",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"is_marketplace": false,
"keypair_name": "keypairname",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"locked": false,
"metadata": "",
"modified_at": "2026-04-14T15:06:26.964Z",
"name": "servername",
"partition_number": 1,
"planned_compute_os_type": "windows",
"product_category": "compute",
"product_offering": "virtual_server",
"security_groups": [
{
"name": "securitygroup"
}
],
"server_group_id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"server_type": {
"disk": 100,
"ephemeral": 0,
"extra_specs": "",
"id": "s1v1m2",
"name": "s1v1m2",
"ram": 2,
"swap": 0,
"vcpus": 1
},
"state": "ACTIVE",
"volumes": [
{
"delete_on_termination": false,
"id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
],
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
4.1.90.2 - 1.1
get /v1/servers/{server_id}
Description
Show Virtual Server.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerShowResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"addresses": [
{
"ip_addresses": [
{
"ip_address": "192.169.3.2",
"version": 4
}
],
"subnet_name": "subnetname"
}
],
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2026-04-14T15:06:24.507Z",
"created_by": "97e6b22c9a4143789ca522df7457a32f",
"disk_config": "MANUAL",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"is_marketplace": false,
"keypair_name": "keypairname",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"locked": false,
"metadata": "",
"modified_at": "2026-04-14T15:06:24.507Z",
"name": "servername",
"partition_number": 1,
"planned_compute_os_type": "windows",
"product_category": "compute",
"product_offering": "virtual_server",
"security_groups": [
{
"name": "securitygroup"
}
],
"server_group_id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"server_type": {
"disk": 100,
"ephemeral": 0,
"extra_specs": "",
"id": "s1v1m2",
"name": "s1v1m2",
"ram": 2,
"swap": 0,
"vcpus": 1
},
"state": "ACTIVE",
"volumes": [
{
"delete_on_termination": false,
"id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
],
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
4.1.90.3 - 1.0
get /v1/servers/{server_id}
Description
Show Virtual Server.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerShowResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"addresses": [
{
"ip_addresses": [
{
"ip_address": "192.169.3.2",
"version": 4
}
],
"subnet_name": "subnetname"
}
],
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2026-04-14T15:06:21.971Z",
"created_by": "97e6b22c9a4143789ca522df7457a32f",
"disk_config": "MANUAL",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"is_marketplace": false,
"keypair_name": "keypairname",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"locked": false,
"metadata": "",
"modified_at": "2026-04-14T15:06:21.971Z",
"name": "servername",
"partition_number": 1,
"planned_compute_os_type": "windows",
"product_category": "compute",
"product_offering": "virtual_server",
"security_groups": [
{
"name": "securitygroup"
}
],
"server_group_id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"server_type": {
"disk": 100,
"ephemeral": 0,
"extra_specs": "",
"id": "s1v1m2",
"name": "s1v1m2",
"ram": 2,
"swap": 0,
"vcpus": 1
},
"state": "ACTIVE",
"volumes": [
{
"delete_on_termination": false,
"id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
],
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
4.1.91 - Show Virtual Server Console Log
4.1.91.1 - 1.2
get /v1/servers/{server_id}/console-log
Description
Show Virtual Server Console Log.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| query | line_size optional | Number of log lines to get Example : 1 | any of [integer, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerConsoleLogResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/console-log
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"output": "FAKE CONSOLE OUTPUT"
}
4.1.91.2 - 1.1
get /v1/servers/{server_id}/console-log
Description
Show Virtual Server Console Log.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| query | line_size optional | Number of log lines to get Example : 1 | any of [integer, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerConsoleLogResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/console-log
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"output": "FAKE CONSOLE OUTPUT"
}
4.1.91.3 - 1.0
get /v1/servers/{server_id}/console-log
Description
Show Virtual Server Console Log.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| query | line_size optional | Number of log lines to get Example : 1 | any of [integer, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerConsoleLogResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/console-log
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"output": "FAKE CONSOLE OUTPUT"
}
4.1.92 - Show Virtual Server Password
4.1.92.1 - 1.2
post /v1/servers/{server_id}/password
Description
Show Virtual Server Password.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| body | body required | ServerPasswordRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerPasswordResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/password
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"private_key": "-----BEGIN RSA PRIVATE KEY-----\nfakeKey\n-----END RSA PRIVATE KEY-----"
}
Example HTTP response
Response 200
{
"password": "password"
}
4.1.92.2 - 1.1
post /v1/servers/{server_id}/password
Description
Show Virtual Server Password.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| body | body required | ServerPasswordRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerPasswordResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/password
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"private_key": "-----BEGIN RSA PRIVATE KEY-----\nfakeKey\n-----END RSA PRIVATE KEY-----"
}
Example HTTP response
Response 200
{
"password": "password"
}
4.1.92.3 - 1.0
post /v1/servers/{server_id}/password
Description
Show Virtual Server Password.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| body | body required | ServerPasswordRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerPasswordResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/password
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"private_key": "-----BEGIN RSA PRIVATE KEY-----\nfakeKey\n-----END RSA PRIVATE KEY-----"
}
Example HTTP response
Response 200
{
"password": "password"
}
4.1.93 - Show Volume Quota Set
4.1.93.1 - 1.2
get /v1/volumes/quota-sets
Description
Show volume quota set.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VolumeQuotaSet |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/volumes/quota-sets
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"id": "fc7283354c6143a58629b59f4c3e16b2",
"per_volume_size": {
"in_use": 10,
"limit": "",
"reserved": 0
},
"snapshots": {
"in_use": 10,
"limit": "",
"reserved": 0
},
"usages": {
"in_use": 10,
"limit": "",
"reserved": 0
},
"volumes": {
"in_use": 10,
"limit": "",
"reserved": 0
}
}
4.1.93.2 - 1.1
get /v1/volumes/quota-sets
Description
Show volume quota set.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VolumeQuotaSet |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/volumes/quota-sets
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"id": "fc7283354c6143a58629b59f4c3e16b2",
"per_volume_size": {
"in_use": 10,
"limit": "",
"reserved": 0
},
"snapshots": {
"in_use": 10,
"limit": "",
"reserved": 0
},
"usages": {
"in_use": 10,
"limit": "",
"reserved": 0
},
"volumes": {
"in_use": 10,
"limit": "",
"reserved": 0
}
}
4.1.93.3 - 1.0
get /v1/volumes/quota-sets
Description
Show volume quota set.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VolumeQuotaSet |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/volumes/quota-sets
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"id": "fc7283354c6143a58629b59f4c3e16b2",
"per_volume_size": {
"in_use": 10,
"limit": "",
"reserved": 0
},
"snapshots": {
"in_use": 10,
"limit": "",
"reserved": 0
},
"usages": {
"in_use": 10,
"limit": "",
"reserved": 0
},
"volumes": {
"in_use": 10,
"limit": "",
"reserved": 0
}
}
4.1.94 - Show volume transfer detail
4.1.94.1 - 1.2
get /v1/volume-transfer/{transfer_id}
Description
Show volume transfer detail.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transfer_id required | Volume Transfer ID Example : 1ac231be-823b-4a4d-8ff0-aac503a7118a | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VolumeTransferShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/volume-transfer/{transfer_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"created_at": "2025-07-22T09:00:00Z",
"id": "1ac231be-823b-4a4d-8ff0-aac503a7118a",
"name": "volume01",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
4.1.94.2 - 1.1
get /v1/volume-transfer/{transfer_id}
Description
Show volume transfer detail.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transfer_id required | Volume Transfer ID Example : 1ac231be-823b-4a4d-8ff0-aac503a7118a | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VolumeTransferShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/volume-transfer/{transfer_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"created_at": "2025-07-22T09:00:00Z",
"id": "1ac231be-823b-4a4d-8ff0-aac503a7118a",
"name": "volume01",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
4.1.94.3 - 1.0
get /v1/volume-transfer/{transfer_id}
Description
Show volume transfer detail.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transfer_id required | Volume Transfer ID Example : 1ac231be-823b-4a4d-8ff0-aac503a7118a | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VolumeTransferShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/volume-transfer/{transfer_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"created_at": "2025-07-22T09:00:00Z",
"id": "1ac231be-823b-4a4d-8ff0-aac503a7118a",
"name": "volume01",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
4.1.95 - Show Volume type’s details
4.1.95.1 - 1.2
get /v1/volume-types/{volume_type_id}
Description
Show a Volume type’s details.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | volume_type_id required | Volume type ID Example : c643ac35-3aec-43e6-b97a-3d6f666c5207 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VolumeTypeDetailResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 500 | Internal Server Error | None |
Example HTTP request
Request path
/v1/volume-types/{volume_type_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"description": "Volume type description",
"extra_specs": {
"multiattach": "<is> True"
},
"id": "c643ac35-3aec-43e6-b97a-3d6f666c5207",
"name": "SSD"
}
4.1.95.2 - 1.1
get /v1/volume-types/{volume_type_id}
Description
Show a Volume type’s details.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | volume_type_id required | Volume type ID Example : c643ac35-3aec-43e6-b97a-3d6f666c5207 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VolumeTypeDetailResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 500 | Internal Server Error | None |
Example HTTP request
Request path
/v1/volume-types/{volume_type_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"description": "Volume type description",
"extra_specs": {
"multiattach": "<is> True"
},
"id": "c643ac35-3aec-43e6-b97a-3d6f666c5207",
"name": "SSD"
}
4.1.95.3 - 1.0
get /v1/volume-types/{volume_type_id}
Description
Show a Volume type’s details.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | volume_type_id required | Volume type ID Example : c643ac35-3aec-43e6-b97a-3d6f666c5207 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VolumeTypeDetailResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 500 | Internal Server Error | None |
Example HTTP request
Request path
/v1/volume-types/{volume_type_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"description": "Volume type description",
"extra_specs": {
"multiattach": "<is> True"
},
"id": "c643ac35-3aec-43e6-b97a-3d6f666c5207",
"name": "SSD"
}
4.1.96 - Show Volume's details
4.1.96.1 - 1.2
get /v1/volumes/{volume_id}
Description
Show a Volume’s details.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | volume_id required | Volume ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VolumeShowResponseV1Dot2 |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/volumes/{volume_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 200
{
"bootable": false,
"created_at": "2026-04-14T15:06:28.049Z",
"encrypted": true,
"id": "3f500f00-ed80-4566-a057-e31760226f9a",
"max_iops": 10000,
"max_throughput": 500,
"modified_at": "2025-07-26T12:00:00Z",
"multiattach": false,
"name": "volume01",
"servers": [
{
"attached_at": "2026-04-14T15:06:28.049Z",
"device": "/dev/vda",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
}
],
"size": 104,
"snapshot_id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"state": "available",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_image_metadata": {
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"disk_format": "qcow2",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"min_disk": 100,
"min_ram": 0,
"os_distro": "alma",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"signature_verified": false,
"size": 2429747200
},
"volume_type": "SSD",
"volume_type_id": "c643ac35-3aec-43e6-b97a-3d6f666c5207"
}
4.1.96.2 - 1.1
get /v1/volumes/{volume_id}
Description
Show a Volume’s details.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | volume_id required | Volume ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VolumeShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/volumes/{volume_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"bootable": false,
"created_at": "2026-04-14T15:06:25.551Z",
"encrypted": true,
"id": "3f500f00-ed80-4566-a057-e31760226f9a",
"modified_at": "2025-07-26T12:00:00Z",
"multiattach": false,
"name": "volume01",
"servers": [
{
"attached_at": "2026-04-14T15:06:25.551Z",
"device": "/dev/vda",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
}
],
"size": 104,
"snapshot_id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"state": "available",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_image_metadata": {
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"disk_format": "qcow2",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"min_disk": 100,
"min_ram": 0,
"os_distro": "alma",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"signature_verified": false,
"size": 2429747200
},
"volume_type": "SSD",
"volume_type_id": "c643ac35-3aec-43e6-b97a-3d6f666c5207"
}
4.1.96.3 - 1.0
get /v1/volumes/{volume_id}
Description
Show a Volume’s details.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | volume_id required | Volume ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VolumeShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/volumes/{volume_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"bootable": false,
"created_at": "2026-04-14T15:06:23.053Z",
"encrypted": true,
"id": "3f500f00-ed80-4566-a057-e31760226f9a",
"modified_at": "2025-07-26T12:00:00Z",
"multiattach": false,
"name": "volume01",
"servers": [
{
"attached_at": "2026-04-14T15:06:23.053Z",
"device": "/dev/vda",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
}
],
"size": 104,
"snapshot_id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"state": "available",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_image_metadata": {
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"disk_format": "qcow2",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"min_disk": 100,
"min_ram": 0,
"os_distro": "alma",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"signature_verified": false,
"size": 2429747200
},
"volume_type": "SSD",
"volume_type_id": "c643ac35-3aec-43e6-b97a-3d6f666c5207"
}
4.1.97 - Start Virtual Server
4.1.97.1 - 1.2
post /v1/servers/{server_id}/start
Description
Start Virtual Server.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/start
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 202
4.1.97.2 - 1.1
post /v1/servers/{server_id}/start
Description
Start Virtual Server.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/start
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 202
4.1.97.3 - 1.0
post /v1/servers/{server_id}/start
Description
Start Virtual Server.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/start
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 202
4.1.98 - Stop Virtual Server
4.1.98.1 - 1.2
post /v1/servers/{server_id}/stop
Description
Stop Virtual Server.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/stop
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 202
4.1.98.2 - 1.1
post /v1/servers/{server_id}/stop
Description
Stop Virtual Server.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/stop
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 202
4.1.98.3 - 1.0
post /v1/servers/{server_id}/stop
Description
Stop Virtual Server.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/stop
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 202
4.1.99 - Unlock Virtual Server
4.1.99.1 - 1.2
post /v1/servers/{server_id}/unlock
Description
Unlock Virtual Server.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/unlock
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Example HTTP response
Response 202
4.1.99.2 - 1.1
post /v1/servers/{server_id}/unlock
Description
Unlock Virtual Server.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/unlock
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 202
4.1.99.3 - 1.0
post /v1/servers/{server_id}/unlock
Description
Unlock Virtual Server.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/unlock
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 202
4.1.100 - Update a snapshot
4.1.100.1 - 1.2
put /v1/snapshots/{snapshot_id}
Description
Update a snapshot.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | snapshot_id required | Snapshot ID Example : cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 | string | None |
| body | body required | SnapshotUpdateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SnapshotDetailResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/snapshots/{snapshot_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"description": "description",
"name": "snapshot-1"
}
Example HTTP response
Response 200
{
"created_at": "2025-07-22T09:00:00Z",
"description": "description",
"id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"metadata": "Metadata",
"name": "snapshot-1",
"size": 104,
"status": "available",
"updated_at": "2025-07-26T12:00:00Z",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
4.1.100.2 - 1.1
put /v1/snapshots/{snapshot_id}
Description
Update a snapshot.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | snapshot_id required | Snapshot ID Example : cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 | string | None |
| body | body required | SnapshotUpdateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SnapshotDetailResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/snapshots/{snapshot_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"description": "description",
"name": "snapshot-1"
}
Example HTTP response
Response 200
{
"created_at": "2025-07-22T09:00:00Z",
"description": "description",
"id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"metadata": "Metadata",
"name": "snapshot-1",
"size": 104,
"status": "available",
"updated_at": "2025-07-26T12:00:00Z",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
4.1.100.3 - 1.0
put /v1/snapshots/{snapshot_id}
Description
Update a snapshot.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | snapshot_id required | Snapshot ID Example : cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 | string | None |
| body | body required | SnapshotUpdateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SnapshotDetailResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/snapshots/{snapshot_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"description": "description",
"name": "snapshot-1"
}
Example HTTP response
Response 200
{
"created_at": "2025-07-22T09:00:00Z",
"description": "description",
"id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"metadata": "Metadata",
"name": "snapshot-1",
"size": 104,
"status": "available",
"updated_at": "2025-07-26T12:00:00Z",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
4.1.101 - Update Auto-Scaling Group
4.1.101.1 - 1.2
put /v1/auto-scaling-groups/{auto_scaling_group_id}
Description
Update Auto-Scaling Group.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| body | body required | AutoScalingGroupSetRequestV1Dot2 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupShowResponseV1Dot2 |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"desired_server_count_editable": true,
"drain_enabled": true,
"drain_timeout": 300,
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"security_group_ids": [
"c09c3f05-03d9-443f-b27a-40e0f973c75f"
],
"state_check_delay_time": 300,
"use_lb_state_check": true
}
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"desired_server_count": 1,
"desired_server_count_editable": true,
"drain_enabled": true,
"drain_timeout": 300,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"launch_configuration_name": "launch-configuration-name",
"lb_server_groups": [],
"max_server_count": 2,
"min_server_count": 1,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "auto-scaling-group-name",
"security_group_ids": [
"c09c3f05-03d9-443f-b27a-40e0f973c75f"
],
"server_name_prefix": "server-name-prefix",
"state": "IN_SERVICE",
"state_check_delay_time": 300,
"subnet_ids": [],
"total_server_count": 1,
"use_lb_state_check": true,
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
4.1.101.2 - 1.1
put /v1/auto-scaling-groups/{auto_scaling_group_id}
Description
Update Auto-Scaling Group.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| body | body required | AutoScalingGroupSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"desired_server_count_editable": true,
"drain_enabled": true,
"drain_timeout": 300,
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"security_group_ids": [
"c09c3f05-03d9-443f-b27a-40e0f973c75f"
]
}
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"desired_server_count": 1,
"desired_server_count_editable": true,
"drain_enabled": true,
"drain_timeout": 300,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"launch_configuration_name": "launch-configuration-name",
"lb_server_groups": [],
"max_server_count": 2,
"min_server_count": 1,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "auto-scaling-group-name",
"security_group_ids": [
"c09c3f05-03d9-443f-b27a-40e0f973c75f"
],
"server_name_prefix": "server-name-prefix",
"state": "IN_SERVICE",
"subnet_ids": [],
"total_server_count": 1,
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
4.1.101.3 - 1.0
put /v1/auto-scaling-groups/{auto_scaling_group_id}
Description
Update Auto-Scaling Group.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| body | body required | AutoScalingGroupSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"desired_server_count_editable": true,
"drain_enabled": true,
"drain_timeout": 300,
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"security_group_ids": [
"c09c3f05-03d9-443f-b27a-40e0f973c75f"
]
}
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"desired_server_count": 1,
"desired_server_count_editable": true,
"drain_enabled": true,
"drain_timeout": 300,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"launch_configuration_name": "launch-configuration-name",
"lb_server_groups": [],
"max_server_count": 2,
"min_server_count": 1,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "auto-scaling-group-name",
"security_group_ids": [
"c09c3f05-03d9-443f-b27a-40e0f973c75f"
],
"server_name_prefix": "server-name-prefix",
"state": "IN_SERVICE",
"subnet_ids": [],
"total_server_count": 1,
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
4.1.102 - Update Auto-Scaling Group LB Server Groups
4.1.102.1 - 1.2
put /v1/auto-scaling-groups/{auto_scaling_group_id}/lb-server-groups
Description
Update Auto-Scaling Group LB Server Groups.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| body | body required | AutoScalingGroupLbServerGroupSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/lb-server-groups
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"lb_server_groups": [
{
"id": "d06e87d3-ca9a-461b-8e88-077a542a7335",
"port": 8080
}
]
}
Example HTTP response
Response 202
4.1.102.2 - 1.1
put /v1/auto-scaling-groups/{auto_scaling_group_id}/lb-server-groups
Description
Update Auto-Scaling Group LB Server Groups.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| body | body required | AutoScalingGroupLbServerGroupSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/lb-server-groups
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"lb_server_groups": [
{
"id": "d06e87d3-ca9a-461b-8e88-077a542a7335",
"port": 8080
}
]
}
Example HTTP response
Response 202
4.1.102.3 - 1.0
put /v1/auto-scaling-groups/{auto_scaling_group_id}/lb-server-groups
Description
Update Auto-Scaling Group LB Server Groups.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| body | body required | AutoScalingGroupLbServerGroupSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/lb-server-groups
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"lb_server_groups": [
{
"id": "d06e87d3-ca9a-461b-8e88-077a542a7335",
"port": 8080
}
]
}
Example HTTP response
Response 202
4.1.103 - Update Auto-Scaling Group Notification
4.1.103.1 - 1.2
put /v1/auto-scaling-groups/{auto_scaling_group_id}/notifications/{notification_id}
Description
Update Auto-Scaling Group notification.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| path | notification_id required | Auto-Scaling Group notification ID Example : fa7fd191410744cd810a290c0b4d22b9 | string | None |
| body | body required | AutoScalingGroupNotificationUpdateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupNotificationShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/notifications/{notification_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"notification_events": [
"SCALE_OUT",
"SCALE_OUT_FAIL"
],
"notification_state": "ACTIVE"
}
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"notification_events": [
"SCALE_OUT",
"SCALE_OUT_FAIL"
],
"notification_state": "ACTIVE",
"user_email": "scpuser@samsung.com",
"user_id": "570907805e5447be84b618450ef52o0t",
"user_name": "scpuser"
}
4.1.103.2 - 1.1
put /v1/auto-scaling-groups/{auto_scaling_group_id}/notifications/{notification_id}
Description
Update Auto-Scaling Group notification.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| path | notification_id required | Auto-Scaling Group notification ID Example : fa7fd191410744cd810a290c0b4d22b9 | string | None |
| body | body required | AutoScalingGroupNotificationUpdateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupNotificationShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/notifications/{notification_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"notification_events": [
"SCALE_OUT",
"SCALE_OUT_FAIL"
],
"notification_state": "ACTIVE"
}
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"notification_events": [
"SCALE_OUT",
"SCALE_OUT_FAIL"
],
"notification_state": "ACTIVE",
"user_email": "scpuser@samsung.com",
"user_id": "570907805e5447be84b618450ef52o0t",
"user_name": "scpuser"
}
4.1.103.3 - 1.0
put /v1/auto-scaling-groups/{auto_scaling_group_id}/notifications/{notification_id}
Description
Update Auto-Scaling Group notification.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| path | notification_id required | Auto-Scaling Group notification ID Example : fa7fd191410744cd810a290c0b4d22b9 | string | None |
| body | body required | AutoScalingGroupNotificationUpdateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupNotificationShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/notifications/{notification_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"notification_events": [
"SCALE_OUT",
"SCALE_OUT_FAIL"
],
"notification_state": "ACTIVE"
}
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"notification_events": [
"SCALE_OUT",
"SCALE_OUT_FAIL"
],
"notification_state": "ACTIVE",
"user_email": "scpuser@samsung.com",
"user_id": "570907805e5447be84b618450ef52o0t",
"user_name": "scpuser"
}
4.1.104 - Update Auto-Scaling Group Policy
4.1.104.1 - 1.2
put /v1/auto-scaling-groups/{auto_scaling_group_id}/policies/{policy_id}
Description
Update Auto-Scaling Group policy.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| path | policy_id required | Policy ID Example : 0761d76085f54363bab07909baf69841 | string | None |
| body | body required | AutoScalingGroupPolicyUpdateRequestV1Dot2 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupPolicyShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/policies/{policy_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"comparison_operator": "ge",
"cooldown_seconds": 300,
"evaluation_minutes": 5,
"metric_method": "AVG",
"metric_type": "CPU",
"scale_method": "AMOUNT",
"scale_type": "SCALE_OUT",
"scale_value": 10,
"state": "ACTIVE",
"threshold": 60
}
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"comparison_operator": "ge",
"cooldown_seconds": 300,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"evaluation_minutes": 5,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"metric_method": "AVG",
"metric_type": "CPU",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "policy-name",
"scale_method": "AMOUNT",
"scale_type": "SCALE_OUT",
"scale_value": 10,
"state": "ACTIVE",
"threshold": 60,
"threshold_unit": "%"
}
4.1.104.2 - 1.1
put /v1/auto-scaling-groups/{auto_scaling_group_id}/policies/{policy_id}
Description
Update Auto-Scaling Group policy.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| path | policy_id required | Policy ID Example : 0761d76085f54363bab07909baf69841 | string | None |
| body | body required | AutoScalingGroupPolicyUpdateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupPolicyShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/policies/{policy_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"comparison_operator": "ge",
"cooldown_seconds": 300,
"evaluation_minutes": 5,
"metric_method": "AVG",
"metric_type": "CPU",
"name": "policy-name",
"scale_method": "AMOUNT",
"scale_type": "SCALE_OUT",
"scale_value": 10,
"state": "ACTIVE",
"threshold": 60
}
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"comparison_operator": "ge",
"cooldown_seconds": 300,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"evaluation_minutes": 5,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"metric_method": "AVG",
"metric_type": "CPU",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "policy-name",
"scale_method": "AMOUNT",
"scale_type": "SCALE_OUT",
"scale_value": 10,
"state": "ACTIVE",
"threshold": 60,
"threshold_unit": "%"
}
4.1.104.3 - 1.0
put /v1/auto-scaling-groups/{auto_scaling_group_id}/policies/{policy_id}
Description
Update Auto-Scaling Group policy.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| path | policy_id required | Policy ID Example : 0761d76085f54363bab07909baf69841 | string | None |
| body | body required | AutoScalingGroupPolicyUpdateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupPolicyShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/policies/{policy_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"comparison_operator": "ge",
"cooldown_seconds": 300,
"evaluation_minutes": 5,
"metric_method": "AVG",
"metric_type": "CPU",
"name": "policy-name",
"scale_method": "AMOUNT",
"scale_type": "SCALE_OUT",
"scale_value": 10,
"state": "ACTIVE",
"threshold": 60
}
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"comparison_operator": "ge",
"cooldown_seconds": 300,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"evaluation_minutes": 5,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"metric_method": "AVG",
"metric_type": "CPU",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "policy-name",
"scale_method": "AMOUNT",
"scale_type": "SCALE_OUT",
"scale_value": 10,
"state": "ACTIVE",
"threshold": 60,
"threshold_unit": "%"
}
4.1.105 - Update Auto-Scaling Group Schedule
4.1.105.1 - 1.2
put /v1/auto-scaling-groups/{auto_scaling_group_id}/schedules/{schedule_id}
Description
Update Auto-Scaling Group schedule.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| path | schedule_id required | Schedule ID Example : 43d4841abd404220af5f0904037aba71 | string | None |
| body | body required | AutoScalingGroupScheduleUpdateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupScheduleShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/schedules/{schedule_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"day_of_month": "-1,1",
"day_of_week": "SU,SA",
"description": "description",
"desired_server_count": 1,
"end_date": "2025-01-01",
"frequency": "WEEKLY",
"hour": 9,
"max_server_count": 2,
"min_server_count": 1,
"minute": 0,
"name": "schedulename",
"start_date": "2024-01-01",
"state": "ACTIVE",
"timezone": "Asia/Seoul"
}
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"day_of_month": "-1,1",
"day_of_week": "SU,SA",
"description": "description",
"desired_server_count": 1,
"end_date": "2025-01-01",
"frequency": "WEEKLY",
"hour": 9,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"max_server_count": 2,
"min_server_count": 1,
"minute": 0,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "schedulename",
"start_date": "2024-01-01",
"state": "ACTIVE",
"timezone": "Asia/Seoul"
}
4.1.105.2 - 1.1
put /v1/auto-scaling-groups/{auto_scaling_group_id}/schedules/{schedule_id}
Description
Update Auto-Scaling Group schedule.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| path | schedule_id required | Schedule ID Example : 43d4841abd404220af5f0904037aba71 | string | None |
| body | body required | AutoScalingGroupScheduleUpdateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupScheduleShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/schedules/{schedule_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"day_of_month": "-1,1",
"day_of_week": "SU,SA",
"description": "description",
"desired_server_count": 1,
"end_date": "2025-01-01",
"frequency": "WEEKLY",
"hour": 9,
"max_server_count": 2,
"min_server_count": 1,
"minute": 0,
"name": "schedulename",
"start_date": "2024-01-01",
"state": "ACTIVE",
"timezone": "Asia/Seoul"
}
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"day_of_month": "-1,1",
"day_of_week": "SU,SA",
"description": "description",
"desired_server_count": 1,
"end_date": "2025-01-01",
"frequency": "WEEKLY",
"hour": 9,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"max_server_count": 2,
"min_server_count": 1,
"minute": 0,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "schedulename",
"start_date": "2024-01-01",
"state": "ACTIVE",
"timezone": "Asia/Seoul"
}
4.1.105.3 - 1.0
put /v1/auto-scaling-groups/{auto_scaling_group_id}/schedules/{schedule_id}
Description
Update Auto-Scaling Group schedule.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| path | schedule_id required | Schedule ID Example : 43d4841abd404220af5f0904037aba71 | string | None |
| body | body required | AutoScalingGroupScheduleUpdateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupScheduleShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/schedules/{schedule_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"day_of_month": "-1,1",
"day_of_week": "SU,SA",
"description": "description",
"desired_server_count": 1,
"end_date": "2025-01-01",
"frequency": "WEEKLY",
"hour": 9,
"max_server_count": 2,
"min_server_count": 1,
"minute": 0,
"name": "schedulename",
"start_date": "2024-01-01",
"state": "ACTIVE",
"timezone": "Asia/Seoul"
}
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"day_of_month": "-1,1",
"day_of_week": "SU,SA",
"description": "description",
"desired_server_count": 1,
"end_date": "2025-01-01",
"frequency": "WEEKLY",
"hour": 9,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"max_server_count": 2,
"min_server_count": 1,
"minute": 0,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "schedulename",
"start_date": "2024-01-01",
"state": "ACTIVE",
"timezone": "Asia/Seoul"
}
4.1.106 - Update Auto-Scaling Group server count
4.1.106.1 - 1.2
put /v1/auto-scaling-groups/{auto_scaling_group_id}/server-count
Description
Update Auto-Scaling Group server count.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| body | body required | AutoScalingGroupSetServerCountRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupShowResponseV1Dot2 |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/server-count
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"desired_server_count": 1,
"max_server_count": 2,
"min_server_count": 1
}
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"desired_server_count": 1,
"desired_server_count_editable": true,
"drain_enabled": true,
"drain_timeout": 300,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"launch_configuration_name": "launch-configuration-name",
"lb_server_groups": [],
"max_server_count": 2,
"min_server_count": 1,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "auto-scaling-group-name",
"security_group_ids": [
"c09c3f05-03d9-443f-b27a-40e0f973c75f"
],
"server_name_prefix": "server-name-prefix",
"state": "IN_SERVICE",
"state_check_delay_time": 300,
"subnet_ids": [],
"total_server_count": 1,
"use_lb_state_check": true,
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
4.1.106.2 - 1.1
put /v1/auto-scaling-groups/{auto_scaling_group_id}/server-count
Description
Update Auto-Scaling Group server count.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| body | body required | AutoScalingGroupSetServerCountRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/server-count
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"desired_server_count": 1,
"max_server_count": 2,
"min_server_count": 1
}
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"desired_server_count": 1,
"desired_server_count_editable": true,
"drain_enabled": true,
"drain_timeout": 300,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"launch_configuration_name": "launch-configuration-name",
"lb_server_groups": [],
"max_server_count": 2,
"min_server_count": 1,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "auto-scaling-group-name",
"security_group_ids": [
"c09c3f05-03d9-443f-b27a-40e0f973c75f"
],
"server_name_prefix": "server-name-prefix",
"state": "IN_SERVICE",
"subnet_ids": [],
"total_server_count": 1,
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
4.1.106.3 - 1.0
put /v1/auto-scaling-groups/{auto_scaling_group_id}/server-count
Description
Update Auto-Scaling Group server count.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| body | body required | AutoScalingGroupSetServerCountRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/server-count
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"desired_server_count": 1,
"max_server_count": 2,
"min_server_count": 1
}
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"desired_server_count": 1,
"desired_server_count_editable": true,
"drain_enabled": true,
"drain_timeout": 300,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"launch_configuration_name": "launch-configuration-name",
"lb_server_groups": [],
"max_server_count": 2,
"min_server_count": 1,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "auto-scaling-group-name",
"security_group_ids": [
"c09c3f05-03d9-443f-b27a-40e0f973c75f"
],
"server_name_prefix": "server-name-prefix",
"state": "IN_SERVICE",
"subnet_ids": [],
"total_server_count": 1,
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
4.1.107 - Update Image
4.1.107.1 - 1.2
put /v1/images/{image_id}
Description
Update Image.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | image_id required | Image ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | None |
| body | body required | ImageSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ImageShowResponseV1Dot2 |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/images/{image_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"min_disk": 100,
"min_ram": 0,
"protected": false,
"visibility": "private"
}
Example HTTP response
Response 200
{
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"created_at": "2025-07-22T09:00:00Z",
"disk_format": "qcow2",
"file": "/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file",
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"min_disk": 100,
"min_ram": 0,
"name": "imagename",
"os_distro": "alma",
"os_hash_algo": "sha512",
"os_hash_value": "c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99",
"os_hidden": false,
"owner": "a8f10467abfc4b87b64614ab36eb9ae4",
"owner_account_name": "AccountName",
"owner_user_name": "user@samsung.com",
"protected": false,
"root_device_name": "/dev/vda",
"scp_gpu_driver": "535.183.06",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"scp_os_build_version": "20250101",
"scp_os_version": "8.8",
"size": 2429747200,
"status": "active",
"updated_at": "2025-07-26T12:00:00Z",
"url": "https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2",
"virtual_size": 17179869184,
"visibility": "private",
"volumes": "[{\"tag\": null, \"volume_id\": null, \"encryption_options\": null, \"encryption_secret_uuid\": null, \"encryption_format\": null, \"device_name\": \"/dev/vda\", \"disk_bus\": \"virtio\", \"volume_type\": null, \"encrypted\": null, \"image_id\": null, \"device_type\": \"disk\", \"source_type\": \"snapshot\", \"delete_on_termination\": false, \"volume_size\": 104, \"guest_format\": null, \"boot_index\": 0, \"destination_type\": \"volume\", \"snapshot_id\": \"abde9e38-2ed5-4ecd-b23c-b0120e30690e\", \"no_device\": null}]"
}
4.1.107.2 - 1.1
put /v1/images/{image_id}
Description
Update Image.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | image_id required | Image ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | None |
| body | body required | ImageSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ImageShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/images/{image_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"min_disk": 100,
"min_ram": 0,
"protected": false,
"visibility": "private"
}
Example HTTP response
Response 200
{
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"created_at": "2025-07-22T09:00:00Z",
"disk_format": "qcow2",
"file": "/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file",
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"min_disk": 100,
"min_ram": 0,
"name": "imagename",
"os_distro": "alma",
"os_hash_algo": "sha512",
"os_hash_value": "c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99",
"os_hidden": false,
"owner": "a8f10467abfc4b87b64614ab36eb9ae4",
"owner_account_name": "AccountName",
"owner_user_name": "user@samsung.com",
"protected": false,
"root_device_name": "/dev/vda",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"scp_os_build_version": "20250101",
"scp_os_version": "8.8",
"size": 2429747200,
"status": "active",
"updated_at": "2025-07-26T12:00:00Z",
"url": "https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2",
"virtual_size": 17179869184,
"visibility": "private",
"volumes": "[{\"tag\": null, \"volume_id\": null, \"encryption_options\": null, \"encryption_secret_uuid\": null, \"encryption_format\": null, \"device_name\": \"/dev/vda\", \"disk_bus\": \"virtio\", \"volume_type\": null, \"encrypted\": null, \"image_id\": null, \"device_type\": \"disk\", \"source_type\": \"snapshot\", \"delete_on_termination\": false, \"volume_size\": 104, \"guest_format\": null, \"boot_index\": 0, \"destination_type\": \"volume\", \"snapshot_id\": \"abde9e38-2ed5-4ecd-b23c-b0120e30690e\", \"no_device\": null}]"
}
4.1.107.3 - 1.0
put /v1/images/{image_id}
Description
Update Image.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | image_id required | Image ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | None |
| body | body required | ImageSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ImageShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/images/{image_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"min_disk": 100,
"min_ram": 0,
"protected": false,
"visibility": "private"
}
Example HTTP response
Response 200
{
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"created_at": "2025-07-22T09:00:00Z",
"disk_format": "qcow2",
"file": "/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file",
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"min_disk": 100,
"min_ram": 0,
"name": "imagename",
"os_distro": "alma",
"os_hash_algo": "sha512",
"os_hash_value": "c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99",
"os_hidden": false,
"owner": "a8f10467abfc4b87b64614ab36eb9ae4",
"owner_account_name": "AccountName",
"owner_user_name": "user@samsung.com",
"protected": false,
"root_device_name": "/dev/vda",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"scp_os_build_version": "20250101",
"scp_os_version": "8.8",
"size": 2429747200,
"status": "active",
"updated_at": "2025-07-26T12:00:00Z",
"url": "https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2",
"virtual_size": 17179869184,
"visibility": "private",
"volumes": "[{\"tag\": null, \"volume_id\": null, \"encryption_options\": null, \"encryption_secret_uuid\": null, \"encryption_format\": null, \"device_name\": \"/dev/vda\", \"disk_bus\": \"virtio\", \"volume_type\": null, \"encrypted\": null, \"image_id\": null, \"device_type\": \"disk\", \"source_type\": \"snapshot\", \"delete_on_termination\": false, \"volume_size\": 104, \"guest_format\": null, \"boot_index\": 0, \"destination_type\": \"volume\", \"snapshot_id\": \"abde9e38-2ed5-4ecd-b23c-b0120e30690e\", \"no_device\": null}]"
}
4.1.108 - Update Image member
4.1.108.1 - 1.2
put /v1/images/{image_id}/members/{member_id}
Description
Update Image member.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | image_id required | Image ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | None |
| path | member_id required | Shared Image member ID Example : a8f10467abfc4b87b64614ab36eb9ae4 | string | None |
| body | body required | ImageMemberSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ImageMemberShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/images/{image_id}/members/{member_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"status": "pending"
}
Example HTTP response
Response 200
{
"created_at": "2025-07-22T09:00:00Z",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"member_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"status": "pending",
"updated_at": "2025-07-26T12:00:00Z"
}
4.1.108.2 - 1.1
put /v1/images/{image_id}/members/{member_id}
Description
Update Image member.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | image_id required | Image ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | None |
| path | member_id required | Shared Image member ID Example : a8f10467abfc4b87b64614ab36eb9ae4 | string | None |
| body | body required | ImageMemberSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ImageMemberShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/images/{image_id}/members/{member_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"status": "pending"
}
Example HTTP response
Response 200
{
"created_at": "2025-07-22T09:00:00Z",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"member_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"status": "pending",
"updated_at": "2025-07-26T12:00:00Z"
}
4.1.108.3 - 1.0
put /v1/images/{image_id}/members/{member_id}
Description
Update Image member.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | image_id required | Image ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | None |
| path | member_id required | Shared Image member ID Example : a8f10467abfc4b87b64614ab36eb9ae4 | string | None |
| body | body required | ImageMemberSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ImageMemberShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/images/{image_id}/members/{member_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"status": "pending"
}
Example HTTP response
Response 200
{
"created_at": "2025-07-22T09:00:00Z",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"member_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"status": "pending",
"updated_at": "2025-07-26T12:00:00Z"
}
4.1.109 - Update Server Interface
4.1.109.1 - 1.2
put /v1/servers/{server_id}/interfaces/{port_id}
Description
Update Server Interface.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| path | port_id required | Port ID Example : 91424c08-0b26-49fb-9808-ed042292ceef | string | None |
| body | body required | ServerInterfaceUpdateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces/{port_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"fixed_ip_address": "192.169.3.2",
"subnet_id": ""
}
Example HTTP response
Response 202
4.1.109.2 - 1.1
put /v1/servers/{server_id}/interfaces/{port_id}
Description
Update Server Interface.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| path | port_id required | Port ID Example : 91424c08-0b26-49fb-9808-ed042292ceef | string | None |
| body | body required | ServerInterfaceUpdateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces/{port_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"fixed_ip_address": "192.169.3.2",
"subnet_id": ""
}
Example HTTP response
Response 202
4.1.109.3 - 1.0
put /v1/servers/{server_id}/interfaces/{port_id}
Description
Update Server Interface.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| path | port_id required | Port ID Example : 91424c08-0b26-49fb-9808-ed042292ceef | string | None |
| body | body required | ServerInterfaceUpdateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces/{port_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"fixed_ip_address": "192.169.3.2",
"subnet_id": ""
}
Example HTTP response
Response 202
4.1.110 - Update Server Volume
4.1.110.1 - 1.2
put /v1/servers/{server_id}/volumes/{volume_id}
Description
Update Server Volume.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| path | volume_id required | Volume ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string | None |
| body | body required | ServerVolumesUpdateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/volumes/{volume_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"delete_on_termination": false,
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
Example HTTP response
Response 200
4.1.110.2 - 1.1
put /v1/servers/{server_id}/volumes/{volume_id}
Description
Update Server Volume.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| path | volume_id required | Volume ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string | None |
| body | body required | ServerVolumesUpdateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/volumes/{volume_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"delete_on_termination": false,
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
Example HTTP response
Response 200
4.1.110.3 - 1.0
put /v1/servers/{server_id}/volumes/{volume_id}
Description
Update Server Volume.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| path | volume_id required | Volume ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string | None |
| body | body required | ServerVolumesUpdateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/volumes/{volume_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"delete_on_termination": false,
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
Example HTTP response
Response 200
4.1.111 - Update Virtual Server
4.1.111.1 - 1.2
put /v1/servers/{server_id}
Description
Update Virtual Server.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| body | body required | ServerUpdateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"name": "servername"
}
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"addresses": [
{
"ip_addresses": [
{
"ip_address": "192.169.3.2",
"version": 4
}
],
"subnet_name": "subnetname"
}
],
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2026-04-14T15:06:26.981Z",
"created_by": "97e6b22c9a4143789ca522df7457a32f",
"disk_config": "MANUAL",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"is_marketplace": false,
"keypair_name": "keypairname",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"locked": false,
"metadata": "",
"modified_at": "2026-04-14T15:06:26.981Z",
"name": "servername",
"partition_number": 1,
"planned_compute_os_type": "windows",
"product_category": "compute",
"product_offering": "virtual_server",
"security_groups": [
{
"name": "securitygroup"
}
],
"server_group_id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"server_type": {
"disk": 100,
"ephemeral": 0,
"extra_specs": "",
"id": "s1v1m2",
"name": "s1v1m2",
"ram": 2,
"swap": 0,
"vcpus": 1
},
"state": "ACTIVE",
"volumes": [
{
"delete_on_termination": false,
"id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
],
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
4.1.111.2 - 1.1
put /v1/servers/{server_id}
Description
Update Virtual Server.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| body | body required | ServerUpdateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"name": "servername"
}
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"addresses": [
{
"ip_addresses": [
{
"ip_address": "192.169.3.2",
"version": 4
}
],
"subnet_name": "subnetname"
}
],
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2026-04-14T15:06:24.525Z",
"created_by": "97e6b22c9a4143789ca522df7457a32f",
"disk_config": "MANUAL",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"is_marketplace": false,
"keypair_name": "keypairname",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"locked": false,
"metadata": "",
"modified_at": "2026-04-14T15:06:24.525Z",
"name": "servername",
"partition_number": 1,
"planned_compute_os_type": "windows",
"product_category": "compute",
"product_offering": "virtual_server",
"security_groups": [
{
"name": "securitygroup"
}
],
"server_group_id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"server_type": {
"disk": 100,
"ephemeral": 0,
"extra_specs": "",
"id": "s1v1m2",
"name": "s1v1m2",
"ram": 2,
"swap": 0,
"vcpus": 1
},
"state": "ACTIVE",
"volumes": [
{
"delete_on_termination": false,
"id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
],
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
4.1.111.3 - 1.0
put /v1/servers/{server_id}
Description
Update Virtual Server.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| body | body required | ServerUpdateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"name": "servername"
}
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"addresses": [
{
"ip_addresses": [
{
"ip_address": "192.169.3.2",
"version": 4
}
],
"subnet_name": "subnetname"
}
],
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2026-04-14T15:06:21.989Z",
"created_by": "97e6b22c9a4143789ca522df7457a32f",
"disk_config": "MANUAL",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"is_marketplace": false,
"keypair_name": "keypairname",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"locked": false,
"metadata": "",
"modified_at": "2026-04-14T15:06:21.989Z",
"name": "servername",
"partition_number": 1,
"planned_compute_os_type": "windows",
"product_category": "compute",
"product_offering": "virtual_server",
"security_groups": [
{
"name": "securitygroup"
}
],
"server_group_id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"server_type": {
"disk": 100,
"ephemeral": 0,
"extra_specs": "",
"id": "s1v1m2",
"name": "s1v1m2",
"ram": 2,
"swap": 0,
"vcpus": 1
},
"state": "ACTIVE",
"volumes": [
{
"delete_on_termination": false,
"id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
],
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
4.1.112 - Update Virtual Server type
4.1.112.1 - 1.2
post /v1/servers/{server_id}/server-type
Description
Update Virtual Server type
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| body | body required | ServerSetServerTypeRequestBody |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/server-type
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"server_type": "s1v1m2"
}
Example HTTP response
Response 202
4.1.112.2 - 1.1
post /v1/servers/{server_id}/server-type
Description
Update Virtual Server type
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| body | body required | ServerSetServerTypeRequestBody |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/server-type
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"server_type": "s1v1m2"
}
Example HTTP response
Response 202
4.1.112.3 - 1.0
post /v1/servers/{server_id}/server-type
Description
Update Virtual Server type
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| body | body required | ServerSetServerTypeRequestBody |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/server-type
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"server_type": "s1v1m2"
}
Example HTTP response
Response 202
4.1.113 - Update Volume
4.1.113.1 - 1.2
put /v1/volumes/{volume_id}
Description
Update a Volume.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | volume_id required | Volume ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string | None |
| body | body required | VolumeUpdateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VolumeShowResponseV1Dot2 |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/volumes/{volume_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"
Request body
{
"name": "volume01"
}
Example HTTP response
Response 200
{
"bootable": false,
"created_at": "2026-04-14T15:06:28.066Z",
"encrypted": true,
"id": "3f500f00-ed80-4566-a057-e31760226f9a",
"max_iops": 10000,
"max_throughput": 500,
"modified_at": "2025-07-26T12:00:00Z",
"multiattach": false,
"name": "volume01",
"servers": [
{
"attached_at": "2026-04-14T15:06:28.066Z",
"device": "/dev/vda",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
}
],
"size": 104,
"snapshot_id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"state": "available",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_image_metadata": {
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"disk_format": "qcow2",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"min_disk": 100,
"min_ram": 0,
"os_distro": "alma",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"signature_verified": false,
"size": 2429747200
},
"volume_type": "SSD",
"volume_type_id": "c643ac35-3aec-43e6-b97a-3d6f666c5207"
}
4.1.113.2 - 1.1
put /v1/volumes/{volume_id}
Description
Update a Volume.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | volume_id required | Volume ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string | None |
| body | body required | VolumeUpdateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VolumeShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/volumes/{volume_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"name": "volume01"
}
Example HTTP response
Response 200
{
"bootable": false,
"created_at": "2026-04-14T15:06:25.569Z",
"encrypted": true,
"id": "3f500f00-ed80-4566-a057-e31760226f9a",
"modified_at": "2025-07-26T12:00:00Z",
"multiattach": false,
"name": "volume01",
"servers": [
{
"attached_at": "2026-04-14T15:06:25.569Z",
"device": "/dev/vda",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
}
],
"size": 104,
"snapshot_id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"state": "available",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_image_metadata": {
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"disk_format": "qcow2",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"min_disk": 100,
"min_ram": 0,
"os_distro": "alma",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"signature_verified": false,
"size": 2429747200
},
"volume_type": "SSD",
"volume_type_id": "c643ac35-3aec-43e6-b97a-3d6f666c5207"
}
4.1.113.3 - 1.0
put /v1/volumes/{volume_id}
Description
Update a Volume.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | volume_id required | Volume ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string | None |
| body | body required | VolumeUpdateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VolumeShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/volumes/{volume_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"name": "volume01"
}
Example HTTP response
Response 200
{
"bootable": false,
"created_at": "2026-04-14T15:06:23.070Z",
"encrypted": true,
"id": "3f500f00-ed80-4566-a057-e31760226f9a",
"modified_at": "2025-07-26T12:00:00Z",
"multiattach": false,
"name": "volume01",
"servers": [
{
"attached_at": "2026-04-14T15:06:23.070Z",
"device": "/dev/vda",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
}
],
"size": 104,
"snapshot_id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"state": "available",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_image_metadata": {
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"disk_format": "qcow2",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"min_disk": 100,
"min_ram": 0,
"os_distro": "alma",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"signature_verified": false,
"size": 2429747200
},
"volume_type": "SSD",
"volume_type_id": "c643ac35-3aec-43e6-b97a-3d6f666c5207"
}
4.2 - Models
4.2.1 - AutoScalingGroup
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : a8f10467abfc4b87b64614ab36eb9ae4 | string | |
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| desired_server_count required | Desired server count Example : 1 | integer | |
| desired_server_count_editable required | Desired server count editable Example : True | boolean | |
| drain_enabled required | Drain enabled Example : True | boolean | |
| drain_timeout optional | Drain timeout Example : 300 | any of [integer, null] | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| launch_configuration_id required | Launch Configuration ID Example : b5aea5a675fc4f6b9e0fcd1288354c5f | string | |
| launch_configuration_name required | Launch Configuration name Example : launch-configuration-name | string | |
| lb_server_groups optional | LB Server Group list | any of [array[AutoScalingGroupLbServerGroup], null] | |
| max_server_count required | Max server count Example : 2 | integer | |
| min_server_count required | Min server count Example : 1 | integer | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name required | Auto-Scaling Group name Example : auto-scaling-group-name | string | |
| security_group_ids optional | Security Group ID list Example : ['c09c3f05-03d9-443f-b27a-40e0f973c75f'] | any of [array[string], null] | |
| server_name_prefix required | Server name prefix Example : server-name-prefix | string | |
| state required | Auto-Scaling Group state Example : IN_SERVICE | string | |
| subnet_ids optional | Subnet ID list | array[string] | |
| vpc_id required | VPC ID Example : cc976b621087484ea5fd527f4b78708b | string |
4.2.2 - AutoScalingGroupCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| desired_server_count required | Desired server count Example : 1 | integer | |
| desired_server_count_editable required | Desired server count editable Example : True | boolean | |
| drain_enabled optional | Drain enabled Example : True | any of [boolean, null] | |
| drain_timeout optional | Drain timeout Example : 300 | any of [integer, null] | |
| launch_configuration_id required | Launch Configuration ID Example : b5aea5a675fc4f6b9e0fcd1288354c5f | string | |
| lb_server_groups optional | LB Server Group list | any of [array[AutoScalingGroupLbServerGroup], null] | |
| max_server_count required | Max server count Example : 2 | integer | |
| min_server_count required | Min server count Example : 1 | integer | |
| name required | Auto-Scaling Group name Example : auto-scaling-group-namePattern : ^[a-zA-Z0-9-_]*$Minimum length : 1Maximum length : 63 | string | |
| notifications optional | Auto-Scaling Group notifications | any of [array[AutoScalingGroupNotificationCreateRequest], null] | |
| scaling_policies optional | Auto-Scaling Group policy list | any of [array[AutoScalingGroupPolicyCreateRequest], null] | |
| security_group_ids optional | Security Group ID list Example : ['c09c3f05-03d9-443f-b27a-40e0f973c75f'] | any of [array[string], null] | |
| server_name_prefix required | Server name prefix Example : server-name-prefixPattern : ^[a-zA-Z0-9-_]*$Minimum length : 1Maximum length : 61 | string | |
| subnet_ids required | Subnet ID list | array[string] | |
| tags optional | Tags Example : [{'key': 'key', 'value': 'value'}] | any of [array[Tag], null] |
4.2.3 - AutoScalingGroupCreateRequestV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| desired_server_count required | Desired server count Example : 1 | integer | |
| desired_server_count_editable required | Desired server count editable Example : True | boolean | |
| drain_enabled optional | Drain enabled Example : True | any of [boolean, null] | |
| drain_timeout optional | Drain timeout Example : 300 | any of [integer, null] | |
| launch_configuration_id required | Launch Configuration ID Example : b5aea5a675fc4f6b9e0fcd1288354c5f | string | |
| lb_server_groups optional | LB Server Group list | any of [array[AutoScalingGroupLbServerGroup], null] | |
| max_server_count required | Max server count Example : 2 | integer | |
| min_server_count required | Min server count Example : 1 | integer | |
| name required | Auto-Scaling Group name Example : auto-scaling-group-namePattern : ^[a-zA-Z0-9-_]*$Minimum length : 1Maximum length : 63 | string | |
| notifications optional | Auto-Scaling Group notifications | any of [array[AutoScalingGroupNotificationCreateRequest], null] | |
| scaling_policies optional | Auto-Scaling Group policy list | any of [array[AutoScalingGroupPolicyCreateRequest], null] | |
| security_group_ids optional | Security Group ID list Example : ['c09c3f05-03d9-443f-b27a-40e0f973c75f'] | any of [array[string], null] | |
| server_name_prefix required | Server name prefix Example : server-name-prefixPattern : ^[a-zA-Z0-9-_]*$Minimum length : 1Maximum length : 61 | string | |
| state_check_delay_time required | The delay time between ASG VM creation and state check operation Example : 300Maximum : 2147483647 | integer | |
| subnet_ids required | Subnet ID list | array[string] | |
| tags optional | Tags Example : [{'key': 'key', 'value': 'value'}] | any of [array[Tag], null] | |
| use_lb_state_check required | Whether LB state check operates or not Example : True | boolean |
4.2.4 - AutoScalingGroupLbServerGroup
| Name | Description | Schema | Default |
|---|---|---|---|
| id required | LB Server Group ID Example : d06e87d3-ca9a-461b-8e88-077a542a7335 | string | |
| port required | LB Server Group port Example : 8080Minimum : 1Maximum : 65534 | integer |
4.2.5 - AutoScalingGroupLbServerGroupListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| lb_server_groups required | LB Server Group list | array[AutoScalingGroupLbServerGroupShowResponse] |
4.2.6 - AutoScalingGroupLbServerGroupSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| lb_server_groups required | LB Server Group list | array[AutoScalingGroupLbServerGroup] |
4.2.7 - AutoScalingGroupLbServerGroupShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name required | LB Server Group name Example : lb-server-group-name | string | |
| port required | LB Server Group port Example : 8080 | integer |
4.2.8 - AutoScalingGroupListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| auto_scaling_groups required | Auto-Scaling Group list | array[AutoScalingGroup] | |
| count required | count Example : 20 | integer |
4.2.9 - AutoScalingGroupListResponseV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| auto_scaling_groups required | Auto-Scaling Group list | array[AutoScalingGroupV1Dot2] | |
| count required | count Example : 20 | integer |
4.2.10 - AutoScalingGroupNotificationCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| notification_events required | Auto-Scaling Group notification event list Example : ['SCALE_OUT', 'SCALE_OUT_FAIL'] | array[enum (SCALE_OUT, SCALE_OUT_FAIL, SCALE_IN, SCALE_IN_FAIL, SATISFIED_POLICY_CONDITIONS)] | |
| user_ids required | User ID list Example : ['570907805e5447be84b618450ef52o0t'] | array[string] |
4.2.11 - AutoScalingGroupNotificationListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| notifications required | Auto-Scaling Group notification list | array[AutoScalingGroupNotificationShowResponse] |
4.2.12 - AutoScalingGroupNotificationShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : a8f10467abfc4b87b64614ab36eb9ae4 | string | |
| auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | |
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| notification_events required | Auto-Scaling Group notification event list Example : ['SCALE_OUT', 'SCALE_OUT_FAIL'] | array[enum (SCALE_OUT, SCALE_OUT_FAIL, SCALE_IN, SCALE_IN_FAIL, SATISFIED_POLICY_CONDITIONS)] | |
| notification_state required | Auto-Scaling Group notification state Example : ACTIVE | string | |
| user_email required | User email Example : scpuser@samsung.com | string | |
| user_id required | User ID Example : 570907805e5447be84b618450ef52o0t | string | |
| user_name required | User name Example : scpuser | string |
4.2.13 - AutoScalingGroupNotificationUpdateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| notification_events optional | Auto-Scaling Group notification event list Example : ['SCALE_OUT', 'SCALE_OUT_FAIL'] | any of [array[enum (SCALE_OUT, SCALE_OUT_FAIL, SCALE_IN, SCALE_IN_FAIL, SATISFIED_POLICY_CONDITIONS)], null] | |
| notification_state optional | Auto-Scaling Group notification state Example : ACTIVE | any of [string, null] |
4.2.14 - AutoScalingGroupPolicyCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| comparison_operator required | Comparison operator Example : gePattern : ^(ge|gt|le|lt)$ | string | |
| cooldown_seconds required | Cooldown seconds Example : 300 | integer | |
| evaluation_minutes required | Evaluation minutes Example : 5 | integer | |
| metric_method required | Metric method Example : AVGPattern : ^(AVG|MIN|MAX)$ | string | |
| metric_type required | Metric type Example : CPUPattern : ^(CPU|NETWORK_IN_BYTES|NETWORK_OUT_BYTES|NETWORK_IN_PACKETS|NETWORK_OUT_PACKETS)$ | string | |
| name required | Policy name Example : policy-namePattern : ^[a-zA-Z0-9-_]*$Minimum length : 1Maximum length : 63 | string | |
| scale_method required | Scale method Example : AMOUNTPattern : ^(AMOUNT|PERCENTAGE|FIXED)$ | string | |
| scale_type required | Scale type Example : SCALE_OUTPattern : ^(SCALE_IN|SCALE_OUT)$ | string | |
| scale_value required | Scale value Example : 10 | integer | |
| threshold required | Threshold Example : 60 | integer |
4.2.15 - AutoScalingGroupPolicyListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| policies required | array[AutoScalingGroupPolicyShowResponse] |
4.2.16 - AutoScalingGroupPolicyShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : a8f10467abfc4b87b64614ab36eb9ae4 | string | |
| auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | |
| comparison_operator required | Comparison operator Example : ge | string | |
| cooldown_seconds required | Cooldown seconds Example : 300 | integer | |
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| evaluation_minutes required | Evaluation minutes Example : 5 | integer | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| metric_method required | Metric method Example : AVG | string | |
| metric_type required | Metric type Example : CPU | string | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name required | Policy name Example : policy-name | string | |
| scale_method required | Scale method Example : AMOUNT | string | |
| scale_type required | Scale type Example : SCALE_OUT | string | |
| scale_value required | Scale value Example : 10 | integer | |
| state required | Policy state Example : ACTIVE | string | |
| threshold required | Threshold Example : 60 | integer | |
| threshold_unit required | Threshold unit Example : % | string |
4.2.17 - AutoScalingGroupPolicyUpdateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| comparison_operator optional | Comparison operator Example : gePattern : ^(ge|gt|le|lt)$ | any of [string, null] | |
| cooldown_seconds optional | Cooldown seconds Example : 300 | any of [integer, null] | |
| evaluation_minutes optional | Evaluation minutes Example : 5 | any of [integer, null] | |
| metric_method optional | Metric method Example : AVGPattern : ^(AVG|MIN|MAX)$ | any of [string, null] | |
| metric_type optional | Metric type Example : CPUPattern : ^(CPU|NETWORK_IN_BYTES|NETWORK_OUT_BYTES|NETWORK_IN_PACKETS|NETWORK_OUT_PACKETS)$ | any of [string, null] | |
| name optional | Policy name Example : policy-namePattern : ^[a-zA-Z0-9-_]*$ | any of [string, null] | |
| scale_method optional | Scale method Example : AMOUNTPattern : ^(AMOUNT|PERCENTAGE|FIXED)$ | any of [string, null] | |
| scale_type optional | Scale type Example : SCALE_OUTPattern : ^(SCALE_IN|SCALE_OUT)$ | any of [string, null] | |
| scale_value optional | Scale value Example : 10 | any of [integer, null] | |
| state optional | Policy state Example : ACTIVEPattern : ^(ACTIVE|INACTIVE)$ | any of [string, null] | |
| threshold optional | Threshold Example : 60 | any of [integer, null] |
4.2.18 - AutoScalingGroupPolicyUpdateRequestV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| comparison_operator optional | Comparison operator Example : gePattern : ^(ge|gt|le|lt)$ | any of [string, null] | |
| cooldown_seconds optional | Cooldown seconds Example : 300 | any of [integer, null] | |
| evaluation_minutes optional | Evaluation minutes Example : 5 | any of [integer, null] | |
| metric_method optional | Metric method Example : AVGPattern : ^(AVG|MIN|MAX)$ | any of [string, null] | |
| metric_type optional | Metric type Example : CPUPattern : ^(CPU|NETWORK_IN_BYTES|NETWORK_OUT_BYTES|NETWORK_IN_PACKETS|NETWORK_OUT_PACKETS)$ | any of [string, null] | |
| scale_method optional | Scale method Example : AMOUNTPattern : ^(AMOUNT|PERCENTAGE|FIXED)$ | any of [string, null] | |
| scale_type optional | Scale type Example : SCALE_OUTPattern : ^(SCALE_IN|SCALE_OUT)$ | any of [string, null] | |
| scale_value optional | Scale value Example : 10 | any of [integer, null] | |
| state optional | Policy state Example : ACTIVEPattern : ^(ACTIVE|INACTIVE)$ | any of [string, null] | |
| threshold optional | Threshold Example : 60 | any of [integer, null] |
4.2.19 - AutoScalingGroupScheduleCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| day_of_month optional | Day of the month Example : -1,1 | any of [string, null] | |
| day_of_week optional | Day of the week Example : SU,SA | any of [string, null] | |
| description optional | Description Example : description | any of [string, null] | |
| desired_server_count optional | Desired server count Example : 1 | any of [integer, null] | |
| end_date optional | End date Example : 2025-01-01 | any of [string, null] | |
| frequency required | Frequency Example : WEEKLY | enum (ONCE, DAILY, WEEKLY, MONTHLY) | |
| hour required | Hour Example : 9Maximum : 23 | integer | |
| max_server_count optional | Max server count Example : 2 | any of [integer, null] | |
| min_server_count optional | Min server count Example : 1 | any of [integer, null] | |
| minute required | Minute Example : 0 | integer | |
| name required | Schedule name Example : schedulenamePattern : ^[a-zA-Z0-9-_]*$Minimum length : 1Maximum length : 63 | string | |
| start_date required | Start date Example : 2024-01-01 | string | |
| state optional | Schedule state Example : ACTIVE | enum (ACTIVE, INACTIVE, DELETED) | |
| timezone required | Timezone Example : Asia/Seoul | string |
4.2.20 - AutoScalingGroupScheduleListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| page required | page Example : 0 | integer | |
| schedules required | array[AutoScalingGroupScheduleShowResponse] | ||
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] |
4.2.21 - AutoScalingGroupScheduleShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : a8f10467abfc4b87b64614ab36eb9ae4 | string | |
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| day_of_month required | Day of the month Example : -1,1 | any of [string, null] | |
| day_of_week required | Day of the week Example : SU,SA | any of [string, null] | |
| description required | Description Example : description | any of [string, null] | |
| desired_server_count required | Desired server count Example : 1 | any of [integer, null] | |
| end_date required | End date Example : 2025-01-01 | any of [string, null] | |
| frequency required | Frequency Example : WEEKLY | enum (ONCE, DAILY, WEEKLY, MONTHLY) | |
| hour required | Hour Example : 9 | integer | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| max_server_count required | Max server count Example : 2 | any of [integer, null] | |
| min_server_count required | Min server count Example : 1 | any of [integer, null] | |
| minute required | Minute Example : 0 | integer | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name required | Schedule name Example : schedulename | string | |
| start_date required | Start date Example : 2024-01-01 | string | |
| state required | Schedule state Example : ACTIVE | string | |
| timezone required | Timezone Example : Asia/Seoul | string |
4.2.22 - AutoScalingGroupScheduleUpdateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| day_of_month optional | Day of the month Example : -1,1 | any of [string, null] | |
| day_of_week optional | Day of the week Example : SU,SA | any of [string, null] | |
| description optional | Description Example : description | any of [string, null] | |
| desired_server_count optional | Desired server count Example : 1 | any of [integer, null] | |
| end_date optional | End date Example : 2025-01-01 | any of [string, null] | |
| frequency optional | Frequency Example : WEEKLY | any of [enum (ONCE, DAILY, WEEKLY, MONTHLY), null] | |
| hour optional | Hour Example : 9 | any of [integer, null] | |
| max_server_count optional | Max server count Example : 2 | any of [integer, null] | |
| min_server_count optional | Min server count Example : 1 | any of [integer, null] | |
| minute optional | Minute Example : 0 | any of [integer, null] | |
| name optional | Schedule name Example : schedulenamePattern : ^[a-zA-Z0-9-_]*$ | any of [string, null] | |
| start_date optional | Start date Example : 2024-01-01 | any of [string, null] | |
| state optional | Schedule state Example : ACTIVE | enum (ACTIVE, INACTIVE, DELETED) | |
| timezone optional | Timezone Example : Asia/Seoul | any of [string, null] |
4.2.23 - AutoScalingGroupSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| desired_server_count_editable optional | Desired server count editable Example : True | any of [boolean, null] | |
| drain_enabled optional | Drain enabled Example : True | any of [boolean, null] | |
| drain_timeout optional | Drain timeout Example : 300 | any of [integer, null] | |
| launch_configuration_id optional | Launch Configuration ID Example : b5aea5a675fc4f6b9e0fcd1288354c5f | any of [string, null] | |
| security_group_ids optional | Security Group ID list Example : ['c09c3f05-03d9-443f-b27a-40e0f973c75f'] | any of [array[string], null] |
4.2.24 - AutoScalingGroupSetRequestV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| desired_server_count_editable optional | Desired server count editable Example : True | any of [boolean, null] | |
| drain_enabled optional | Drain enabled Example : True | any of [boolean, null] | |
| drain_timeout optional | Drain timeout Example : 300 | any of [integer, null] | |
| launch_configuration_id optional | Launch Configuration ID Example : b5aea5a675fc4f6b9e0fcd1288354c5f | any of [string, null] | |
| security_group_ids optional | Security Group ID list Example : ['c09c3f05-03d9-443f-b27a-40e0f973c75f'] | any of [array[string], null] | |
| state_check_delay_time optional | The delay time between ASG VM creation and state check operation Example : 300 | any of [integer, null] | |
| use_lb_state_check optional | Whether LB state check operates or not Example : True | any of [boolean, null] |
4.2.25 - AutoScalingGroupSetServerCountRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| desired_server_count optional | Desired server count Example : 1 | any of [integer, null] | |
| max_server_count optional | Max server count Example : 2 | any of [integer, null] | |
| min_server_count optional | Min server count Example : 1 | any of [integer, null] |
4.2.26 - AutoScalingGroupShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : a8f10467abfc4b87b64614ab36eb9ae4 | string | |
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| desired_server_count required | Desired server count Example : 1 | integer | |
| desired_server_count_editable required | Desired server count editable Example : True | boolean | |
| drain_enabled required | Drain enabled Example : True | boolean | |
| drain_timeout optional | Drain timeout Example : 300 | any of [integer, null] | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| launch_configuration_id required | Launch Configuration ID Example : b5aea5a675fc4f6b9e0fcd1288354c5f | string | |
| launch_configuration_name required | Launch Configuration name Example : launch-configuration-name | string | |
| lb_server_groups optional | LB Server Group list | any of [array[AutoScalingGroupLbServerGroup], null] | |
| max_server_count required | Max server count Example : 2 | integer | |
| min_server_count required | Min server count Example : 1 | integer | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name required | Auto-Scaling Group name Example : auto-scaling-group-name | string | |
| security_group_ids optional | Security Group ID list Example : ['c09c3f05-03d9-443f-b27a-40e0f973c75f'] | any of [array[string], null] | |
| server_name_prefix required | Server name prefix Example : server-name-prefix | string | |
| state required | Auto-Scaling Group state Example : IN_SERVICE | string | |
| subnet_ids optional | Subnet ID list | array[string] | |
| total_server_count required | Total server count Example : 1 | integer | |
| vpc_id required | VPC ID Example : cc976b621087484ea5fd527f4b78708b | string |
4.2.27 - AutoScalingGroupShowResponseV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : a8f10467abfc4b87b64614ab36eb9ae4 | string | |
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| desired_server_count required | Desired server count Example : 1 | integer | |
| desired_server_count_editable required | Desired server count editable Example : True | boolean | |
| drain_enabled required | Drain enabled Example : True | boolean | |
| drain_timeout optional | Drain timeout Example : 300 | any of [integer, null] | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| launch_configuration_id required | Launch Configuration ID Example : b5aea5a675fc4f6b9e0fcd1288354c5f | string | |
| launch_configuration_name required | Launch Configuration name Example : launch-configuration-name | string | |
| lb_server_groups optional | LB Server Group list | any of [array[AutoScalingGroupLbServerGroup], null] | |
| max_server_count required | Max server count Example : 2 | integer | |
| min_server_count required | Min server count Example : 1 | integer | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name required | Auto-Scaling Group name Example : auto-scaling-group-name | string | |
| security_group_ids optional | Security Group ID list Example : ['c09c3f05-03d9-443f-b27a-40e0f973c75f'] | any of [array[string], null] | |
| server_name_prefix required | Server name prefix Example : server-name-prefix | string | |
| state required | Auto-Scaling Group state Example : IN_SERVICE | string | |
| state_check_delay_time required | The delay time between ASG VM creation and state check operation Example : 300 | integer | |
| subnet_ids optional | Subnet ID list | array[string] | |
| total_server_count required | Total server count Example : 1 | integer | |
| use_lb_state_check required | Whether LB state check operates or not Example : True | boolean | |
| vpc_id required | VPC ID Example : cc976b621087484ea5fd527f4b78708b | string |
4.2.28 - AutoScalingGroupV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : a8f10467abfc4b87b64614ab36eb9ae4 | string | |
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| desired_server_count required | Desired server count Example : 1 | integer | |
| desired_server_count_editable required | Desired server count editable Example : True | boolean | |
| drain_enabled required | Drain enabled Example : True | boolean | |
| drain_timeout optional | Drain timeout Example : 300 | any of [integer, null] | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| launch_configuration_id required | Launch Configuration ID Example : b5aea5a675fc4f6b9e0fcd1288354c5f | string | |
| launch_configuration_name required | Launch Configuration name Example : launch-configuration-name | string | |
| lb_server_groups optional | LB Server Group list | any of [array[AutoScalingGroupLbServerGroup], null] | |
| max_server_count required | Max server count Example : 2 | integer | |
| min_server_count required | Min server count Example : 1 | integer | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name required | Auto-Scaling Group name Example : auto-scaling-group-name | string | |
| security_group_ids optional | Security Group ID list Example : ['c09c3f05-03d9-443f-b27a-40e0f973c75f'] | any of [array[string], null] | |
| server_name_prefix required | Server name prefix Example : server-name-prefix | string | |
| state required | Auto-Scaling Group state Example : IN_SERVICE | string | |
| state_check_delay_time required | The delay time between ASG VM creation and state check operation Example : 300 | integer | |
| subnet_ids optional | Subnet ID list | array[string] | |
| use_lb_state_check required | Whether LB state check operates or not Example : True | boolean | |
| vpc_id required | VPC ID Example : cc976b621087484ea5fd527f4b78708b | string |
4.2.29 - AutoScalingGroupVirtualServerListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| servers required | Server list | array[AutoScalingGroupVirtualServerShowResponse] |
4.2.30 - AutoScalingGroupVirtualServerListResponseV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| servers required | Server list | array[AutoScalingGroupVirtualServerShowResponseV1Dot2] |
4.2.31 - AutoScalingGroupVirtualServerShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : a8f10467abfc4b87b64614ab36eb9ae4 | string | |
| addresses optional | Addresses | any of [array[ServerShowResponseAddress], null] | |
| auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | |
| created_at required | Created at Example : | string (date-time) | |
| created_by required | Created by Example : 97e6b22c9a4143789ca522df7457a32f | string | |
| disk_config required | Disk config Example : MANUAL | string | |
| id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | |
| image_id optional | Image ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | any of [string, null] | |
| is_marketplace optional | Is Marketplace Example : False | any of [boolean, null] | |
| keypair_name optional | Keypair name Example : keypairname | any of [string, null] | |
| launch_configuration_id optional | Launch Configuration ID Example : b5aea5a675fc4f6b9e0fcd1288354c5f | any of [string, null] | |
| lb_linked_state optional | Load Balancer linked state Example : ATTACHED | any of [string, null] | |
| locked required | Locked Example : False | boolean | |
| metadata required | Metadata Example : | object | |
| modified_at required | Modified at Example : | string (date-time) | |
| name required | Server name Example : servername | string | |
| partition_number optional | Partition number Example : 1 | any of [integer, null] | |
| planned_compute_os_type optional | Planned Compute OS type Example : windows | any of [enum (open_source, windows, rhel), null] | |
| product_category optional | Product category Example : compute | any of [enum (compute, container), null] | |
| product_offering optional | Product offering Example : virtual_server | any of [enum (virtual_server, gpu_server, k8s_vm, k8s_gpu_vm), null] | |
| security_groups optional | Security Groups | any of [array[ServerShowResponseSecurityGroup], null] | |
| server_group_id optional | Server Group ID Example : 616fb98f-46ca-475e-917e-2563e5a8cd19 | any of [string, null] | |
| server_type required | Server type | ServerShowResponseServerType | |
| state required | Server state Example : ACTIVE | string | |
| volumes required | Volumes | array[ServerShowResponseVolume] | |
| vpc_id optional | VPC ID Example : cc976b621087484ea5fd527f4b78708b | any of [string, null] |
4.2.32 - AutoScalingGroupVirtualServerShowResponseV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : a8f10467abfc4b87b64614ab36eb9ae4 | string | |
| addresses optional | Addresses | any of [array[ServerShowResponseAddress], null] | |
| auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | |
| created_at required | Created at Example : | string (date-time) | |
| created_by required | Created by Example : 97e6b22c9a4143789ca522df7457a32f | string | |
| disk_config required | Disk config Example : MANUAL | string | |
| id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | |
| image_id optional | Image ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | any of [string, null] | |
| is_asg_virtual_server_healthy optional | Health state of ASG Virtual Server Example : True | boolean | |
| is_lb_healthy required | LB Health State of ASG Virtual Server Example : True | boolean | |
| is_marketplace optional | Is Marketplace Example : False | any of [boolean, null] | |
| keypair_name optional | Keypair name Example : keypairname | any of [string, null] | |
| launch_configuration_id optional | Launch Configuration ID Example : b5aea5a675fc4f6b9e0fcd1288354c5f | any of [string, null] | |
| lb_linked_state optional | Load Balancer linked state Example : ATTACHED | any of [string, null] | |
| locked required | Locked Example : False | boolean | |
| metadata required | Metadata Example : | object | |
| modified_at required | Modified at Example : | string (date-time) | |
| name required | Server name Example : servername | string | |
| partition_number optional | Partition number Example : 1 | any of [integer, null] | |
| planned_compute_os_type optional | Planned Compute OS type Example : windows | any of [enum (open_source, windows, rhel), null] | |
| product_category optional | Product category Example : compute | any of [enum (compute, container), null] | |
| product_offering optional | Product offering Example : virtual_server | any of [enum (virtual_server, gpu_server, k8s_vm, k8s_gpu_vm), null] | |
| security_groups optional | Security Groups | any of [array[ServerShowResponseSecurityGroup], null] | |
| server_group_id optional | Server Group ID Example : 616fb98f-46ca-475e-917e-2563e5a8cd19 | any of [string, null] | |
| server_type required | Server type | ServerShowResponseServerType | |
| state required | Server state Example : ACTIVE | string | |
| volumes required | Volumes | array[ServerShowResponseVolume] | |
| vpc_id optional | VPC ID Example : cc976b621087484ea5fd527f4b78708b | any of [string, null] |
4.2.33 - DefaultConfigListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| configs required | Configs Example : ('key': 'value'} | object | |
| count required | count Example : 20 | integer |
4.2.34 - ImageCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| container_format optional | Container format Example : barePattern : bare | string | bare |
| disk_format optional | Disk format Example : qcow2Pattern : qcow2 | string | qcow2 |
| min_disk optional | Minimum disk capacity (GB) of the Image to be created Example : 100 | integer | |
| min_ram optional | Minimum RAM capacity (GB) of the Image to be created Example : 0Maximum : 2097151 | integer | |
| name required | Image name Example : imagenamePattern : ^[a-zA-Z0-9-_ ]*$Minimum length : 1Maximum length : 255 | string | |
| os_distro required | OS distribution of the image to be uploaded Example : alma | enum (alma, centos, rhel, rocky, ubuntu, windows, oracle) | |
| protected optional | whether Image deletion is prohibited Example : False | boolean | |
| tags optional | Tags Example : [{'key': 'key', 'value': 'value'}] | any of [array[Tag], null] | |
| url required | Object Storage URL for Image file (only qcow2 format allowed) Example : https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2Maximum length : 255 | string | |
| visibility optional | Indicates access permissions for the Image. Private: Can be used only within the Account, Shared: Can be shared between Accounts Example : privatePattern : private|shared | string | private |
4.2.35 - ImageImportRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| url required | Object Storage URL for Image file (only qcow2 format allowed) Example : https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2Pattern : .*\.qcow2$Maximum length : 255 | string |
4.2.36 - ImageListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| images required | array[ImageShowResponse] |
4.2.37 - ImageListResponseV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| images required | array[ImageShowResponseV1Dot2] |
4.2.38 - ImageMemberCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| member_id required | Shared Image member ID Example : a8f10467abfc4b87b64614ab36eb9ae4Pattern : ^[A-Za-z0-9-]*$Minimum length : 1Maximum length : 64 | string |
4.2.39 - ImageMemberListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| members required | array[ImageMemberShowResponse] |
4.2.40 - ImageMemberSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| status required | Status of this Image member. Value of one of pending, accepted, rejected. Example : pending | enum (pending, accepted, rejected) |
4.2.41 - ImageMemberShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | Created at Example : 2025-07-22T09:00:00Z | string | |
| image_id required | Image ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | |
| member_id required | Shared Image member ID Example : a8f10467abfc4b87b64614ab36eb9ae4 | string | |
| status required | Status of this Image member. Value of one of pending, accepted, rejected. Example : pending | string | |
| updated_at required | Updated at Example : 2025-07-26T12:00:00Z | string |
4.2.42 - ImageSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| min_disk optional | Minimum disk capacity (GB) of the Image to be created Example : 100 | any of [integer, null] | |
| min_ram optional | Minimum RAM capacity (GB) of the Image to be created Example : 0 | any of [integer, null] | |
| protected optional | whether Image deletion is prohibited Example : False | any of [boolean, null] | |
| visibility optional | Indicates access permissions for the Image. Private: Can be used only within the Account, Shared: Can be shared between Accounts Example : privatePattern : private|shared | any of [string, null] |
4.2.43 - ImageShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| checksum optional | MD5 hash of the entire image data. and this field could be used to verify the integrity of image. Example : 7538e0fcb56e0e272cfd89eb384d6613 | any of [string, null] | |
| container_format required | Container format Example : bare | string | |
| created_at required | Created at Example : 2025-07-22T09:00:00Z | string | |
| disk_format required | Disk format Example : qcow2 | string | |
| file required | The URL for the virtual server image file Example : /v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file | string | |
| id required | Image ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | |
| min_disk required | Minimum disk capacity (GB) of the Image to be created Example : 100 | integer | |
| min_ram required | Minimum RAM capacity (GB) of the Image to be created Example : 0 | integer | |
| name required | Image name Example : imagename | string | |
| os_distro optional | OS distribution of the image to be uploaded Example : alma | any of [string, null] | |
| os_hash_algo optional | OS hash algorithm used to verify image integrity Example : sha512 | any of [string, null] | |
| os_hash_value optional | The actual digest of the image binary, calculated with the algorithm indicated by os_hash_algo. The value is presented as a hexadecimal string. Example : c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99 | any of [string, null] | |
| os_hidden required | Whether the image is hidden Example : False | boolean | |
| owner required | Owner account ID Example : a8f10467abfc4b87b64614ab36eb9ae4 | string | |
| owner_account_name optional | Owner account name Example : AccountName | any of [string, null] | |
| owner_user_name optional | Owner user name Example : user@samsung.com | any of [string, null] | |
| protected required | whether Image deletion is prohibited Example : False | boolean | |
| root_device_name optional | Root device name Example : /dev/vda | any of [string, null] | |
| scp_image_type optional | Image type Example : custom | any of [string, null] | |
| scp_k8s_version optional | K8S version Example : v1.28.7 | any of [string, null] | |
| scp_original_image_type optional | Original Image type Example : standard | any of [string, null] | |
| scp_os_build_version optional | OS build version Example : 20250101 | any of [string, null] | |
| scp_os_version optional | OS version Example : 8.8 | any of [string, null] | |
| size optional | Image size Example : 2429747200 | any of [integer, null] | |
| status required | Image status Example : active | string | |
| updated_at required | Updated at Example : 2025-07-26T12:00:00Z | string | |
| url optional | Object Storage URL for Image file (only qcow2 format allowed) Example : https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2 | any of [string, null] | |
| virtual_size optional | Virtual size Example : 17179869184 | any of [integer, null] | |
| visibility required | Indicates access permissions for the Image. Private: Can be used only within the Account, Shared: Can be shared between Accounts Example : private | string | |
| volumes optional | Volumes Example : [{"tag": null, "volume_id": null, "encryption_options": null, "encryption_secret_uuid": null, "encryption_format": null, "device_name": "/dev/vda", "disk_bus": "virtio", "volume_type": null, "encrypted": null, "image_id": null, "device_type": "disk", "source_type": "snapshot", "delete_on_termination": false, "volume_size": 104, "guest_format": null, "boot_index": 0, "destination_type": "volume", "snapshot_id": "abde9e38-2ed5-4ecd-b23c-b0120e30690e", "no_device": null}] | any of [string, null] |
4.2.44 - ImageShowResponseV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| checksum optional | MD5 hash of the entire image data. and this field could be used to verify the integrity of image. Example : 7538e0fcb56e0e272cfd89eb384d6613 | any of [string, null] | |
| container_format required | Container format Example : bare | string | |
| created_at required | Created at Example : 2025-07-22T09:00:00Z | string | |
| disk_format required | Disk format Example : qcow2 | string | |
| file required | The URL for the virtual server image file Example : /v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file | string | |
| id required | Image ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | |
| min_disk required | Minimum disk capacity (GB) of the Image to be created Example : 100 | integer | |
| min_ram required | Minimum RAM capacity (GB) of the Image to be created Example : 0 | integer | |
| name required | Image name Example : imagename | string | |
| os_distro optional | OS distribution of the image to be uploaded Example : alma | any of [string, null] | |
| os_hash_algo optional | OS hash algorithm used to verify image integrity Example : sha512 | any of [string, null] | |
| os_hash_value optional | The actual digest of the image binary, calculated with the algorithm indicated by os_hash_algo. The value is presented as a hexadecimal string. Example : c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99 | any of [string, null] | |
| os_hidden required | Whether the image is hidden Example : False | boolean | |
| owner required | Owner account ID Example : a8f10467abfc4b87b64614ab36eb9ae4 | string | |
| owner_account_name optional | Owner account name Example : AccountName | any of [string, null] | |
| owner_user_name optional | Owner user name Example : user@samsung.com | any of [string, null] | |
| protected required | whether Image deletion is prohibited Example : False | boolean | |
| root_device_name optional | Root device name Example : /dev/vda | any of [string, null] | |
| scp_gpu_driver optional | K8s GPU Image driver version Example : 535.183.06 | any of [string, null] | |
| scp_image_type optional | Image type Example : custom | any of [string, null] | |
| scp_k8s_version optional | K8S version Example : v1.28.7 | any of [string, null] | |
| scp_original_image_type optional | Original Image type Example : standard | any of [string, null] | |
| scp_os_build_version optional | OS build version Example : 20250101 | any of [string, null] | |
| scp_os_version optional | OS version Example : 8.8 | any of [string, null] | |
| size optional | Image size Example : 2429747200 | any of [integer, null] | |
| status required | Image status Example : active | string | |
| updated_at required | Updated at Example : 2025-07-26T12:00:00Z | string | |
| url optional | Object Storage URL for Image file (only qcow2 format allowed) Example : https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2 | any of [string, null] | |
| virtual_size optional | Virtual size Example : 17179869184 | any of [integer, null] | |
| visibility required | Indicates access permissions for the Image. Private: Can be used only within the Account, Shared: Can be shared between Accounts Example : private | string | |
| volumes optional | Volumes Example : [{"tag": null, "volume_id": null, "encryption_options": null, "encryption_secret_uuid": null, "encryption_format": null, "device_name": "/dev/vda", "disk_bus": "virtio", "volume_type": null, "encrypted": null, "image_id": null, "device_type": "disk", "source_type": "snapshot", "delete_on_termination": false, "volume_size": 104, "guest_format": null, "boot_index": 0, "destination_type": "volume", "snapshot_id": "abde9e38-2ed5-4ecd-b23c-b0120e30690e", "no_device": null}] | any of [string, null] |
4.2.45 - InterfaceAttachmentFixedIp
| Name | Description | Schema | Default |
|---|---|---|---|
| ip_address required | IP address Example : 192.169.3.2 | string |
4.2.46 - InterfaceResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| fixed_ips required | Fixed IP list | array[InterfaceAttachmentFixedIp] | |
| mac_addr required | MAC Address Example : fa:16:3e:c0:71:2b | string | |
| port_id required | Port ID Example : f2b02fc5-a5fd-4b5f-b1a9-987f4c0d66cc | string | |
| port_state required | Port State Example : ACTIVE | string | |
| private_static_nat optional | Private Static NAT | PrivateStaticNat | |
| static_nat optional | Public Static NAT | PublicStaticNat | |
| subnet_id required | Subnet ID Example : 183c6c30df0c4fcbb16422aa2d64aa21 | string |
4.2.47 - InterfaceResponseV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| fixed_ips required | Fixed IP list | array[InterfaceAttachmentFixedIp] | |
| is_default required | Indicates whether this is the default port. Example : True | boolean | |
| mac_addr required | MAC Address Example : fa:16:3e:c0:71:2b | string | |
| port_id required | Port ID Example : f2b02fc5-a5fd-4b5f-b1a9-987f4c0d66cc | string | |
| port_state required | Port State Example : ACTIVE | string | |
| private_static_nat optional | Private Static NAT | PrivateStaticNat | |
| static_nat optional | Public Static NAT | PublicStaticNat | |
| subnet_id required | Subnet ID Example : 183c6c30df0c4fcbb16422aa2d64aa21 | string |
4.2.48 - Keypair
| Name | Description | Schema | Default |
|---|---|---|---|
| fingerprint required | Fingerprint Example : 7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd | string | |
| name required | Keypair name Example : keypairname | string | |
| public_key required | Public Key Example : ssh-rsa fakeKey Generated-by-SCP | string | |
| type required | Keypair type Example : ssh | string |
4.2.49 - KeypairCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| name required | Keypair name Example : keypairnamePattern : ^[a-zA-Z0-9-_ ]*$Minimum length : 1Maximum length : 255 | string | |
| public_key optional | Public Key Example : ssh-rsa fakeKey Generated-by-SCP | any of [string, null] | |
| tags optional | Tags Example : [{'key': 'key', 'value': 'value'}] | any of [array[Tag], null] |
4.2.50 - KeypairCreateResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| fingerprint required | Fingerprint Example : 7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd | string | |
| name required | Keypair name Example : keypairname | string | |
| private_key optional | Private key Example : `—–BEGIN RSA PRIVATE KEY—– | ||
| fakeKey | |||
| —–END RSA PRIVATE KEY—–` | any of [string, null] | ||
| public_key required | Public Key Example : ssh-rsa fakeKey Generated-by-SCP | string | |
| type required | Keypair type Example : ssh | string |
4.2.51 - KeypairListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| keypairs required | array[Keypair] |
4.2.52 - KeypairShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | Created at Example : 2025-07-22T09:00:00Z | string (date-time) | |
| fingerprint required | Fingerprint Example : 7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd | string | |
| id required | Keypair ID Example : 1 | integer | |
| name required | Keypair name Example : keypairname | string | |
| public_key required | Public Key Example : ssh-rsa fakeKey Generated-by-SCP | string | |
| type required | Keypair type Example : ssh | string | |
| user_id required | User ID Example : 570907805e5447be84b618450ef52o0t | string |
4.2.53 - LaunchConfigurationCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| image_id required | Image ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | |
| keypair_name required | Keypair name Example : keypairname | string | |
| name required | Launch Configuration name Example : launch-configuration-namePattern : ^[a-zA-Z0-9-_]*$Minimum length : 1Maximum length : 63 | string | |
| server_type_id required | Server type ID Example : s1v1m2 | string | |
| tags optional | Tags Example : [{'key': 'key', 'value': 'value'}] | any of [array[Tag], null] | |
| user_data optional | A script that runs at the start of a server on Auto-Scaling Group that will use Launch Configuration.It must be Base64-encoded string and must not exceed 45,000 bytes. Example : IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg== | any of [string, null] | |
| volumes optional | Volumes | any of [array[LaunchConfigurationVolume], null] |
4.2.54 - LaunchConfigurationDetailShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : a8f10467abfc4b87b64614ab36eb9ae4 | string | |
| auto_scaling_group_count optional | Number of Auto-Scaling Group attached to Launch Configuration Example : 1 | any of [integer, null] | |
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| image_id required | Image ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | |
| image_name required | Image name Example : imagename | string | |
| keypair_name required | Keypair name Example : keypairname | string | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name required | Launch Configuration name Example : launch-configuration-name | string | |
| public_key optional | Public Key Example : ssh-rsa fakeKey Generated-by-SCP | any of [string, null] | |
| server_type_id required | Server type ID Example : s1v1m2 | string | |
| state required | Launch Configuration state Example : ACTIVE | string | |
| user_data optional | A script that runs at the start of a server on Auto-Scaling Group that will use Launch Configuration.It must be Base64-encoded string and must not exceed 45,000 bytes. Example : IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg== | any of [string, null] | |
| volumes optional | Volumes | any of [array[LaunchConfigurationVolume], null] |
4.2.55 - LaunchConfigurationDetailShowResponseV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : a8f10467abfc4b87b64614ab36eb9ae4 | string | |
| auto_scaling_group_count optional | Number of Auto-Scaling Group attached to Launch Configuration Example : 1 | any of [integer, null] | |
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| file_storage_ids optional | File Storage ID list Example : | any of [array[string], null] | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| image_id required | Image ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | |
| image_name required | Image name Example : imagename | string | |
| keypair_name required | Keypair name Example : keypairname | string | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name required | Launch Configuration name Example : launch-configuration-name | string | |
| public_key optional | Public Key Example : ssh-rsa fakeKey Generated-by-SCP | any of [string, null] | |
| server_type_id required | Server type ID Example : s1v1m2 | string | |
| state required | Launch Configuration state Example : ACTIVE | string | |
| user_data optional | A script that runs at the start of a server on Auto-Scaling Group that will use Launch Configuration.It must be Base64-encoded string and must not exceed 45,000 bytes. Example : IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg== | any of [string, null] | |
| volumes optional | Volumes | any of [array[LaunchConfigurationVolumeV1Dot2], null] |
4.2.56 - LaunchConfigurationListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count optional | count Example : 20 | integer | |
| launch_configurations required | Launch Configuration list | array[LaunchConfigurationShowResponse] |
4.2.57 - LaunchConfigurationListResponseV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| count optional | count Example : 20 | integer | |
| launch_configurations required | Launch Configuration list | array[LaunchConfigurationShowResponseV1Dot2] |
4.2.58 - LaunchConfigurationShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : a8f10467abfc4b87b64614ab36eb9ae4 | string | |
| auto_scaling_group_count optional | Number of Auto-Scaling Group attached to Launch Configuration Example : 1 | any of [integer, null] | |
| boot_disk_size optional | Size of default volume Example : 104 | any of [integer, null] | |
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| extra_disk_size optional | Size of additional volume Example : 104 | any of [integer, null] | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| image_id required | Image ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | |
| image_name required | Image name Example : imagename | string | |
| keypair_name required | Keypair name Example : keypairname | string | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name required | Launch Configuration name Example : launch-configuration-name | string | |
| public_key optional | Public Key Example : ssh-rsa fakeKey Generated-by-SCP | any of [string, null] | |
| server_type_id required | Server type ID Example : s1v1m2 | string | |
| state required | Launch Configuration state Example : ACTIVE | string | |
| user_data optional | A script that runs at the start of a server on Auto-Scaling Group that will use Launch Configuration.It must be Base64-encoded string and must not exceed 45,000 bytes. Example : IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg== | any of [string, null] | |
| volumes optional | Volumes | any of [array[LaunchConfigurationVolume], null] |
4.2.59 - LaunchConfigurationShowResponseV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : a8f10467abfc4b87b64614ab36eb9ae4 | string | |
| auto_scaling_group_count optional | Number of Auto-Scaling Group attached to Launch Configuration Example : 1 | any of [integer, null] | |
| boot_disk_size optional | Size of default volume Example : 104 | any of [integer, null] | |
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| extra_disk_size optional | Size of additional volume Example : 104 | any of [integer, null] | |
| file_storage_ids optional | File Storage ID list Example : | any of [array[string], null] | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| image_id required | Image ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | |
| image_name required | Image name Example : imagename | string | |
| keypair_name required | Keypair name Example : keypairname | string | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name required | Launch Configuration name Example : launch-configuration-name | string | |
| public_key optional | Public Key Example : ssh-rsa fakeKey Generated-by-SCP | any of [string, null] | |
| server_type_id required | Server type ID Example : s1v1m2 | string | |
| state required | Launch Configuration state Example : ACTIVE | string | |
| user_data optional | A script that runs at the start of a server on Auto-Scaling Group that will use Launch Configuration.It must be Base64-encoded string and must not exceed 45,000 bytes. Example : IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg== | any of [string, null] | |
| volumes optional | Volumes | any of [array[LaunchConfigurationVolume], null] |
4.2.60 - LaunchConfigurationVolume
| Name | Description | Schema | Default |
|---|---|---|---|
| boot_index required | Boot index Example : 0 | integer | |
| size required | Volume size Example : 104 | integer | |
| type optional | Volume type Example : SSD | any of [string, null] |
4.2.61 - LaunchConfigurationVolumeV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| boot_index required | Boot index Example : 0 | integer | |
| max_iops optional | The number of distinct read or write operations a volume can process in a single second. Example : 10000 | any of [integer, null] | |
| max_throughput optional | The actual amount of data (volume) transferred to or from the storage device per second. Example : 500 | any of [integer, null] | |
| size required | Volume size Example : 104 | integer | |
| type optional | Volume type Example : SSD | any of [string, null] |
4.2.62 - Network
| Name | Description | Schema | Default |
|---|---|---|---|
| fixed_ip optional | Fixed Ip Example : 192.169.3.2 | any of [string, null] | |
| port_id optional | Port ID Example : 91424c08-0b26-49fb-9808-ed042292ceef | any of [string, null] | |
| public_ip_id optional | Public IP ID Example : 615fa9cd5cff486c9de679b3ce63e601 | any of [string, null] | |
| subnet_id optional | Subnet ID Example : 78b2ee3f074145c580ab6abac4821f97 | any of [string, null] |
4.2.63 - PrivateStaticNat
| Name | Description | Schema | Default |
|---|---|---|---|
| external_ip_address required | External IP Address Example : 182.197.61.81 | string | |
| id required | NAT ID Example : 224b80106e6f41b38efe98ac9ddbf280 | string | |
| private_nat_ip_id optional | Private NAT IP ID Example : 1f0cb5390c40483592ddc5a282f53496 | any of [string, null] | |
| state required | NAT State Example : ACTIVE | string |
4.2.64 - PublicStaticNat
| Name | Description | Schema | Default |
|---|---|---|---|
| external_ip_address required | External IP Address Example : 182.197.61.81 | string | |
| id required | NAT ID Example : 224b80106e6f41b38efe98ac9ddbf280 | string | |
| publicip_id optional | Public IP ID Example : 615fa9cd5cff486c9de679b3ce63e601 | any of [string, null] | |
| state required | NAT State Example : ACTIVE | string |
4.2.65 - SecurityGroupResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Security Group owner’s account ID Example : 6f70656e737461636b20342065766572 | string | |
| description required | Security group description Example : Security group description | string | |
| id required | Security Group ID Example : 616fb98f-46ca-475e-917e-2563e5a8cd19 | string | |
| name required | Security Group name Example : securitygroup | string | |
| rules required | Security group rules | array[SecurityGroupResponseRule] |
4.2.66 - SecurityGroupResponseRule
| Name | Description | Schema | Default |
|---|---|---|---|
| from_port required | The port at start of range. Example : 1 | any of [integer, null] | |
| id required | Security group rule ID Example : ca5cb96b-9df6-4af7-9682-4d60a58d38a5 | string | |
| ip_protocol required | IP protocol Example : tcp | any of [string, null] | |
| ip_range optional | IP range | any of [SecurityGroupResponseRuleIpRange, null] | |
| to_port required | The port at end of range. Example : 65535 | any of [integer, null] |
4.2.67 - SecurityGroupResponseRuleIpRange
| Name | Description | Schema | Default |
|---|---|---|---|
| cidr optional | CIDR Example : 0.0.0.0/0 | any of [string, null] |
4.2.68 - ServerConsoleLogResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| output optional | Server console log output Example : FAKE CONSOLE OUTPUT | any of [string, null] |
4.2.69 - ServerCreateImageRequestBody
| Name | Description | Schema | Default |
|---|---|---|---|
| image_name required | Image name Example : imagename | string |
4.2.70 - ServerCreateImageResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| image_id required | Image ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string |
4.2.71 - ServerCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| image_id required | Image ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | |
| keypair_name required | Keypair name Example : keypairname | string | |
| lock optional | Sets the server’s lock status. When the server is locked, most user actions are not allowed. Example : False | any of [boolean, null] | |
| max_count optional | Maximum number of servers to launch. Example : 2 | any of [integer, null] | 1 |
| metadata optional | User can specify custom server metadata as a set of key-value pairs. Example : | any of [object, null] | |
| name required | Server name Example : servernamePattern : ^[a-zA-Z0-9-_ ]*$Minimum length : 1Maximum length : 63 | string | |
| networks required | List of Network | array[Network] | |
| partition_number optional | Sets the target partition number for server creation. only usable if server group type is partition. Example : 1 | any of [integer, null] | |
| product_category optional | Product category Example : compute | any of [enum (compute, container), null] | |
| product_offering optional | Product offering Example : virtual_server | any of [enum (virtual_server, gpu_server, k8s_vm, k8s_gpu_vm), null] | |
| security_groups optional | Security Groups Example : ['c09c3f05-03d9-443f-b27a-40e0f973c75f'] | any of [array[string], null] | |
| server_group_id optional | Server Group ID Example : 616fb98f-46ca-475e-917e-2563e5a8cd19 | any of [string, null] | |
| server_type_id required | Server type ID Example : s1v1m2 | string | |
| tags optional | Tags Example : [{'key': 'key', 'value': 'value'}] | any of [array[Tag], null] | |
| user_data optional | Script or configuration to run when the server starts. it must be Base64-encoded string and must not exceed 65535 bytes. Example : IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg== | any of [string, null] | |
| volumes optional | Volumes | any of [array[Volume], null] |
4.2.72 - ServerCreateRequestV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| file_storage_ids optional | File Storage ID list Example : ['96d258ea-dd5d-4cca-bb3a-b6909b7e2065', '949bd9c7-2098-4284-9685-13268d193117'] | any of [array[string], null] | |
| image_id required | Image ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | |
| keypair_name required | Keypair name Example : keypairname | string | |
| lock optional | Sets the server’s lock status. When the server is locked, most user actions are not allowed. Example : False | any of [boolean, null] | |
| max_count optional | Maximum number of servers to launch. Example : 2 | any of [integer, null] | 1 |
| metadata optional | User can specify custom server metadata as a set of key-value pairs. Example : | any of [object, null] | |
| name required | Server name Example : servernamePattern : ^[a-zA-Z0-9-_ ]*$Minimum length : 1Maximum length : 63 | string | |
| networks required | List of Network | array[Network] | |
| partition_number optional | Sets the target partition number for server creation. only usable if server group type is partition. Example : 1 | any of [integer, null] | |
| product_category optional | Product category Example : compute | any of [enum (compute, container), null] | |
| product_offering optional | Product offering Example : virtual_server | any of [enum (virtual_server, gpu_server, k8s_vm, k8s_gpu_vm), null] | |
| security_groups optional | Security Groups Example : ['c09c3f05-03d9-443f-b27a-40e0f973c75f'] | any of [array[string], null] | |
| server_group_id optional | Server Group ID Example : 616fb98f-46ca-475e-917e-2563e5a8cd19 | any of [string, null] | |
| server_type_id required | Server type ID Example : s1v1m2 | string | |
| tags optional | Tags Example : [{'key': 'key', 'value': 'value'}] | any of [array[Tag], null] | |
| user_data optional | Script or configuration to run when the server starts. it must be Base64-encoded string and must not exceed 65535 bytes. Example : IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg== | any of [string, null] | |
| volumes required | Volumes | array[VolumeV1Dot2] |
4.2.73 - ServerCreateResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| servers required | Server ID list | array[ServerCreateResponseParam] |
4.2.74 - ServerCreateResponseParam
| Name | Description | Schema | Default |
|---|---|---|---|
| id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string |
4.2.75 - ServerGroup
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : a8f10467abfc4b87b64614ab36eb9ae4 | string | |
| id required | Server Group ID Example : 616fb98f-46ca-475e-917e-2563e5a8cd19 | string | |
| members required | List of Virtual Servers belonging to Server Group Example : ['2a9be312-5d4b-4bc8-b2ae-35100fa9241f'] | array[string] | |
| name required | Server Group name Example : server-group | string | |
| partition_size required | Size of partition when server group policy is partition Example : 3 | any of [integer, null] | |
| policy required | Server Group policy Example : anti-affinity | string | |
| user_id required | User ID Example : 570907805e5447be84b618450ef52o0t | string |
4.2.76 - ServerGroupCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| name required | Server Group name Example : server-groupPattern : ^[a-zA-Z0-9-_ ]*$Minimum length : 1Maximum length : 255 | string | |
| policy required | Server Group policy Example : anti-affinityPattern : ^affinity$|^anti-affinity$|^partition$ | string | |
| tags optional | Tags Example : [{'key': 'key', 'value': 'value'}] | any of [array[Tag], null] |
4.2.77 - ServerGroupListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| server_groups required | Server Group list | array[ServerGroup] |
4.2.78 - ServerGroupPartitionSizeResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| partition_size required | Example : | integer |
4.2.79 - ServerInterfaceCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| fixed_ips optional | Fixed IP list | any of [array[InterfaceAttachmentFixedIp], null] | |
| port_id optional | Port ID Example : 91424c08-0b26-49fb-9808-ed042292ceef | any of [string, null] | |
| subnet_id optional | Subnet ID Example : 78b2ee3f074145c580ab6abac4821f97 | any of [string, null] |
4.2.80 - ServerInterfaceListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| interfaces required | Interface List | array[InterfaceResponse] |
4.2.81 - ServerInterfaceListResponseV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| interfaces required | Interface List | array[InterfaceResponseV1Dot2] |
4.2.82 - ServerInterfaceUpdateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| fixed_ip_address optional | IP address Example : 192.169.3.2 | any of [string, null] | |
| subnet_id optional | Subnet ID Example : | any of [string, null] |
4.2.83 - ServerIpsResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| addresses required | IP addresses | array[ServerShowResponseAddress] |
4.2.84 - ServerListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| servers required | Server list | array[ServerShowResponse] |
4.2.85 - ServerPasswordRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| private_key optional | Private key Example : `—–BEGIN RSA PRIVATE KEY—– | ||
| fakeKey | |||
| —–END RSA PRIVATE KEY—–` | any of [string, null] |
4.2.86 - ServerPasswordResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| password optional | Server password Example : password | any of [string, null] |
4.2.87 - ServerPrivateStaticNatCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| private_nat_id required | Private NAT ID Example : 3a6c1dc6b1b24e02a444d672c2798a1c | string | |
| private_nat_ip_id required | Private NAT IP ID Example : 1f0cb5390c40483592ddc5a282f53496 | string |
4.2.88 - ServerQuotaSet
| Name | Description | Schema | Default |
|---|---|---|---|
| cores required | Core quota | ServerQuotaSetObject | |
| id required | Quota set ID Example : fc7283354c6143a58629b59f4c3e16b2 | string | |
| instances required | Instance quota | ServerQuotaSetObject | |
| keypairs required | Keypairs quota | ServerQuotaSetObject | |
| metadata_items required | Metadata items quota | ServerQuotaSetObject | |
| ram required | RAM quota | ServerQuotaSetObject | |
| server_group_members required | Server group members quota | ServerQuotaSetObject | |
| server_groups required | Server groups quota | ServerQuotaSetObject |
4.2.89 - ServerQuotaSetObject
| Name | Description | Schema | Default |
|---|---|---|---|
| in_use required | Quota set in use Example : 10 | integer | |
| limit required | Quota set limit Example : 20 | integer | |
| reserved required | Quota set reserved Example : 0 | integer |
4.2.90 - ServerRebootRequestBody
| Name | Description | Schema | Default |
|---|---|---|---|
| reboot_type optional | Reboot type. A SOFT reboot attempts a graceful shutdown and restart of the server. A HARD reboot attempts a forced shutdown and restart of the server. The HARD reboot corresponds to the power cycles of the server. Example : SOFT | any of [enum (SOFT, HARD), null] | SOFT |
4.2.91 - ServerSecurityGroupActionRequestBody
| Name | Description | Schema | Default |
|---|---|---|---|
| security_group_id required | Security Group ID Example : c09c3f05-03d9-443f-b27a-40e0f973c75f | string |
4.2.92 - ServerSecurityGroupListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| security_groups required | Security Groups | array[SecurityGroupResponse] |
4.2.93 - ServerSetServerTypeRequestBody
| Name | Description | Schema | Default |
|---|---|---|---|
| server_type required | Server type Example : s1v1m2 | string |
4.2.94 - ServerShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : a8f10467abfc4b87b64614ab36eb9ae4 | string | |
| addresses optional | Addresses | any of [array[ServerShowResponseAddress], null] | |
| auto_scaling_group_id optional | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | any of [string, null] | |
| created_at required | Created at Example : | string (date-time) | |
| created_by required | Created by Example : 97e6b22c9a4143789ca522df7457a32f | string | |
| disk_config required | Disk config Example : MANUAL | string | |
| id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | |
| image_id optional | Image ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | any of [string, null] | |
| is_marketplace optional | Is Marketplace Example : False | any of [boolean, null] | |
| keypair_name optional | Keypair name Example : keypairname | any of [string, null] | |
| launch_configuration_id optional | Launch Configuration ID Example : b5aea5a675fc4f6b9e0fcd1288354c5f | any of [string, null] | |
| locked required | Locked Example : False | boolean | |
| metadata required | Metadata Example : | object | |
| modified_at required | Modified at Example : | string (date-time) | |
| name required | Server name Example : servername | string | |
| partition_number optional | Partition number Example : 1 | any of [integer, null] | |
| planned_compute_os_type optional | Planned Compute OS type Example : windows | any of [enum (open_source, windows, rhel), null] | |
| product_category optional | Product category Example : compute | any of [enum (compute, container), null] | |
| product_offering optional | Product offering Example : virtual_server | any of [enum (virtual_server, gpu_server, k8s_vm, k8s_gpu_vm), null] | |
| security_groups optional | Security Groups | any of [array[ServerShowResponseSecurityGroup], null] | |
| server_group_id optional | Server Group ID Example : 616fb98f-46ca-475e-917e-2563e5a8cd19 | any of [string, null] | |
| server_type required | Server type | ServerShowResponseServerType | |
| state required | Server state Example : ACTIVE | string | |
| volumes required | Volumes | array[ServerShowResponseVolume] | |
| vpc_id optional | VPC ID Example : cc976b621087484ea5fd527f4b78708b | any of [string, null] |
4.2.95 - ServerShowResponseAddress
| Name | Description | Schema | Default |
|---|---|---|---|
| ip_addresses required | IP addresses | array[ServerShowResponseAddressIpAddress] | |
| subnet_name required | Subnet name Example : subnetname | string |
4.2.96 - ServerShowResponseAddressIpAddress
| Name | Description | Schema | Default |
|---|---|---|---|
| ip_address required | IP address Example : 192.169.3.2 | string | |
| version required | IP address version Example : 4 | integer |
4.2.97 - ServerShowResponseSecurityGroup
| Name | Description | Schema | Default |
|---|---|---|---|
| name required | Security Group name Example : securitygroup | string |
4.2.98 - ServerShowResponseServerType
| Name | Description | Schema | Default |
|---|---|---|---|
| disk required | Size of root disk Example : 100 | integer | |
| ephemeral required | Size of ephemeral disk Example : 0 | integer | |
| extra_specs required | Extra specs Example : | object | |
| id optional | Server type ID Example : s1v1m2 | any of [string, null] | |
| name required | Server type name Example : s1v1m2 | string | |
| ram required | Amount of RAM Example : 2 | integer | |
| swap required | Size of dedicated swap disk Example : 0 | integer | |
| vcpus required | Number of CPUs Example : 1 | integer |
4.2.99 - ServerShowResponseVolume
| Name | Description | Schema | Default |
|---|---|---|---|
| delete_on_termination required | Delete the boot volume when the server is terminated. Example : False | boolean | |
| id required | Volume ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string |
4.2.100 - ServerStaticNatCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| publicip_id required | Public IP ID Example : 615fa9cd5cff486c9de679b3ce63e601 | string |
4.2.101 - ServersVolumeResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| delete_on_termination required | Delete the boot volume when the server is terminated. Example : False | boolean | |
| device required | Device name such as, /dev/vda. Example : /dev/vda | string | |
| id required | Volume Attachment ID Example : 3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c | string | |
| server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | |
| volume_id required | Volume ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string |
4.2.102 - ServerType
| Name | Description | Schema | Default |
|---|---|---|---|
| description required | Description Example : description | any of [string, null] | |
| disk required | Size of root disk Example : 100 | integer | |
| ephemeral required | Size of ephemeral disk Example : 0 | integer | |
| extra_specs required | Extra specs Example : | object | |
| id required | Server type ID Example : s1v1m2 | string | |
| name required | Server type name Example : s1v1m2 | string | |
| ram required | Amount of RAM Example : 2 | integer | |
| swap required | Size of dedicated swap disk Example : 0 | integer | |
| vcpus required | Number of CPUs Example : 1 | integer |
4.2.103 - ServerTypeListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| server_types required | Server type list | array[ServerType] |
4.2.104 - ServerUpdateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| name required | Server name Example : servernamePattern : ^[a-zA-Z0-9-_ ]*$Minimum length : 1Maximum length : 63 | string |
4.2.105 - ServerVolumesCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| delete_on_termination optional | Delete the boot volume when the server is terminated. Example : False | any of [boolean, null] | |
| device optional | Device name such as, /dev/vda. Example : /dev/vda | any of [string, null] | |
| volume_id required | Volume ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string |
4.2.106 - ServerVolumesResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| volumes required | Volumes | array[ServersVolumeResponse] |
4.2.107 - ServerVolumesUpdateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| delete_on_termination optional | Delete the boot volume when the server is terminated. Example : False | any of [boolean, null] | |
| volume_id required | Volume ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string |
4.2.108 - SnapshotCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | Description Example : description | any of [string, null] | |
| force optional | Whether to create a snapshot even if the volume is attached Example : True | any of [boolean, null] | |
| metadata optional | One or more metadata key and value pairs for the snapshot Example : | any of [object, null] | |
| name required | Snapshot name Example : snapshot-1Pattern : ^[a-zA-Z0-9-_ ]+$Maximum length : 255 | string | |
| volume_id required | Volume ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string |
4.2.109 - SnapshotDetailResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | Created at Example : 2025-07-22T09:00:00Z | string | |
| description optional | Description Example : description | any of [string, null] | |
| id required | Snapshot ID Example : cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 | string | |
| metadata optional | One or more metadata key and value pairs for the snapshot Example : Metadata | any of [object, null] | |
| name optional | Snapshot name Example : snapshot-1 | any of [string, null] | |
| size required | Volume size Example : 104 | integer | |
| status optional | Volume state Example : available | any of [string, null] | |
| updated_at optional | Updated at Example : 2025-07-26T12:00:00Z | any of [string, null] | |
| user_id optional | User ID Example : 570907805e5447be84b618450ef52o0t | any of [string, null] | |
| volume_id required | Volume ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string |
4.2.110 - SnapshotListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count optional | Total count Example : 100 | any of [integer, null] | |
| snapshots required | Snapshot list | array[SnapshotDetailResponse] |
4.2.111 - SnapshotUpdateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | Description Example : description | any of [string, null] | |
| name required | Snapshot name Example : snapshot-1Pattern : ^[a-zA-Z0-9-_ ]+$ | any of [string, null] |
4.2.112 - Tag
| Name | Description | Schema | Default |
|---|---|---|---|
| key required | Key Example : Key | string | |
| value optional | Value Example : Value | any of [string, null] |
4.2.113 - Volume
| Name | Description | Schema | Default |
|---|---|---|---|
| boot_index required | Defines the boot-device order. to disable a device from booting, set its index to None or a negative value. Example : 0 | integer | |
| delete_on_termination optional | Delete the boot volume when the server is terminated. Example : False | any of [boolean, null] | |
| size required | Volume size, in gibibytes(GiB), must be multiple of 8. Example : 104 | integer | |
| source_type optional | Source type of volume. blank is empty volume with no pre-loaded data. image is volume from image. if source type is not set, it defaults to ‘image’ when boot_index is 0. otherwise it defaults to ‘blank’. Example : image | any of [enum (blank, image), null] | |
| type optional | Volume type Example : SSD | any of [string, null] |
4.2.114 - VolumeCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| name required | Volume name Example : volume01Pattern : ^[a-zA-Z0-9-_ ]*$Minimum length : 1Maximum length : 255 | string | |
| size required | Volume size, in gibibytes(GiB), must be multiple of 8. Example : 104Minimum : 8 | integer | |
| snapshot_id optional | Snapshot ID used to create the volume. when specified, request volume size must be greater than or equal to the size of the snapshot. Example : cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 | any of [string, null] | |
| tags optional | Tags Example : [{'key': 'key', 'value': 'value'}] | any of [array[Tag], null] | |
| volume_type optional | Sets the Volume type. if volume type is not set, the volume will be created using default type (SSD). Example : SSD | any of [string, null] |
4.2.115 - VolumeCreateRequestV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| max_iops optional | The number of distinct read or write operations a volume can process in a single second. Example : 10000 | any of [integer, null] | |
| max_throughput optional | The actual amount of data (volume) transferred to or from the storage device per second. Example : 500 | any of [integer, null] | |
| name required | Volume name Example : volume01Pattern : ^[a-zA-Z0-9-_ ]*$Minimum length : 1Maximum length : 255 | string | |
| size required | Volume size, in gibibytes(GiB), must be multiple of 8. Example : 104Minimum : 8 | integer | |
| snapshot_id optional | Snapshot ID used to create the volume. when specified, request volume size must be greater than or equal to the size of the snapshot. Example : cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 | any of [string, null] | |
| tags optional | Tags Example : [{'key': 'key', 'value': 'value'}] | any of [array[Tag], null] | |
| volume_type optional | Sets the Volume type. if volume type is not set, the volume will be created using default type (SSD). Example : SSD | any of [string, null] |
4.2.116 - VolumeExtendRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| size required | Volume size Example : 104Minimum : 8 | integer |
4.2.117 - VolumeImageMetadataResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| checksum optional | MD5 hash of the entire image data. and this field could be used to verify the integrity of image. Example : 7538e0fcb56e0e272cfd89eb384d6613 | any of [string, null] | |
| container_format optional | Container format Example : bare | any of [string, null] | |
| disk_format optional | Disk format Example : qcow2 | any of [string, null] | |
| image_id optional | Image ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | any of [string, null] | |
| image_name optional | Image name Example : imagename | any of [string, null] | |
| min_disk optional | Minimum disk capacity (GB) of the Image to be created Example : 100 | any of [integer, null] | |
| min_ram optional | Minimum RAM capacity (GB) of the Image to be created Example : 0 | any of [integer, null] | |
| os_distro optional | OS distribution of the image to be uploaded Example : alma | any of [string, null] | |
| scp_image_type optional | Image type Example : custom | any of [string, null] | |
| scp_k8s_version optional | K8S version Example : v1.28.7 | any of [string, null] | |
| scp_original_image_type optional | Original Image type Example : standard | any of [string, null] | |
| signature_verified optional | Signature verified Example : False | any of [boolean, null] | |
| size optional | Image size Example : 2429747200 | any of [integer, null] |
4.2.118 - VolumeListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count optional | Total count Example : 100 | any of [integer, null] | |
| volumes required | Volumes | array[VolumeShowResponse] |
4.2.119 - VolumeListResponseV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| count optional | Total count Example : 100 | any of [integer, null] | |
| volumes required | Volumes | array[VolumeShowResponseV1Dot2] |
4.2.120 - VolumeQuotaSet
| Name | Description | Schema | Default |
|---|---|---|---|
| id required | Quota set ID Example : fc7283354c6143a58629b59f4c3e16b2 | string | |
| per_volume_size required | Per volume size quota | VolumeQuotaSetObject | |
| snapshots required | Snapshot Quota | VolumeQuotaSetObject | |
| usages required | Usage quota | VolumeQuotaSetObject | |
| volumes required | Volume Quota | VolumeQuotaSetObject |
4.2.121 - VolumeQuotaSetObject
| Name | Description | Schema | Default |
|---|---|---|---|
| in_use required | Quota set in use Example : 10 | integer | |
| limit required | Quota set limit Example : | integer | |
| reserved required | Quota set reserved Example : 0 | integer |
4.2.122 - VolumeRevertRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| snapshot_id required | Snapshot ID Example : cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 | string |
4.2.123 - VolumeServer
| Name | Description | Schema | Default |
|---|---|---|---|
| attached_at required | The time when the volume was attached to the server. Example : | string (date-time) | |
| device required | Device name such as, /dev/vda. Example : /dev/vda | string | |
| id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string |
4.2.124 - VolumeServerAttachRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| delete_on_termination optional | Delete the boot volume when the server is terminated. Example : False | any of [boolean, null] | |
| server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string |
4.2.125 - VolumeServerAttachResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| delete_on_termination required | Delete the boot volume when the server is terminated. Example : False | boolean | |
| device required | Device name such as, /dev/vda. Example : /dev/vda | string | |
| server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | |
| volume_id required | Volume ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string |
4.2.126 - VolumeSetQosRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| max_iops optional | The number of distinct read or write operations a volume can process in a single second. Example : 10000 | any of [integer, null] | |
| max_throughput optional | The actual amount of data (volume) transferred to or from the storage device per second. Example : 500 | any of [integer, null] |
4.2.127 - VolumeShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| bootable required | Bootable Example : False | boolean | |
| created_at required | Created at Example : | string (date-time) | |
| encrypted required | Encrypted Example : True | boolean | |
| id required | Volume ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string | |
| modified_at optional | Modified at Example : 2025-07-26T12:00:00Z | any of [string (date-time), null] | |
| multiattach required | Connect to two or more servers, no restriction on the number of connected servers per volume, and Virtual Server can connect up to 26 volumes. Example : False | boolean | |
| name optional | Volume name Example : volume01 | any of [string, null] | |
| servers required | Attached servers | array[VolumeServer] | |
| size required | Volume size Example : 104 | integer | |
| snapshot_id optional | Snapshot ID Example : cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 | any of [string, null] | |
| state required | Volume state Example : available | string | |
| user_id required | User ID Example : 570907805e5447be84b618450ef52o0t | string | |
| volume_image_metadata optional | Volume Image metadata | any of [VolumeImageMetadataResponse, null] | |
| volume_type required | Volume type Example : SSD | string | |
| volume_type_id required | Volume type ID Example : c643ac35-3aec-43e6-b97a-3d6f666c5207 | string |
4.2.128 - VolumeShowResponseV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| bootable required | Bootable Example : False | boolean | |
| created_at required | Created at Example : | string (date-time) | |
| encrypted required | Encrypted Example : True | boolean | |
| id required | Volume ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string | |
| max_iops optional | The number of distinct read or write operations a volume can process in a single second. Example : 10000 | any of [integer, null] | |
| max_throughput optional | The actual amount of data (volume) transferred to or from the storage device per second. Example : 500 | any of [integer, null] | |
| modified_at optional | Modified at Example : 2025-07-26T12:00:00Z | any of [string (date-time), null] | |
| multiattach required | Connect to two or more servers, no restriction on the number of connected servers per volume, and Virtual Server can connect up to 26 volumes. Example : False | boolean | |
| name optional | Volume name Example : volume01 | any of [string, null] | |
| servers required | Attached servers | array[VolumeServer] | |
| size required | Volume size Example : 104 | integer | |
| snapshot_id optional | Snapshot ID Example : cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 | any of [string, null] | |
| state required | Volume state Example : available | string | |
| user_id required | User ID Example : 570907805e5447be84b618450ef52o0t | string | |
| volume_image_metadata optional | Volume Image metadata | any of [VolumeImageMetadataResponse, null] | |
| volume_type required | Volume type Example : SSD | string | |
| volume_type_id required | Volume type ID Example : c643ac35-3aec-43e6-b97a-3d6f666c5207 | string |
4.2.129 - VolumeTransferAcceptRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| auth_key required | Auth key Example : f5972fdb456897eb | string |
4.2.130 - VolumeTransferAcceptResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| id required | Volume Transfer ID Example : 1ac231be-823b-4a4d-8ff0-aac503a7118a | string | |
| name optional | Volume name Example : volume01 | any of [string, null] | |
| volume_id required | Volume ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string |
4.2.131 - VolumeTransferCreateResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| auth_key required | Auth key Example : f5972fdb456897eb | string | |
| created_at required | Created at Example : | string | |
| id required | Volume Transfer ID Example : 1ac231be-823b-4a4d-8ff0-aac503a7118a | string | |
| name optional | Volume name Example : volume01 | any of [string, null] | |
| volume_id required | Volume ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string |
4.2.132 - VolumeTransferListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| transfers required | Volume Transfer List | array[VolumeTransferAcceptResponse] |
4.2.133 - VolumeTransferRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| name optional | Volume name Example : volume01 | any of [string, null] | |
| volume_id required | Volume ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string |
4.2.134 - VolumeTransferShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | Created at Example : 2025-07-22T09:00:00Z | string | |
| id required | Volume Transfer ID Example : 1ac231be-823b-4a4d-8ff0-aac503a7118a | string | |
| name optional | Volume name Example : volume01 | any of [string, null] | |
| volume_id required | Volume ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string |
4.2.135 - VolumeTypeDetailResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | Volume type description Example : Volume type description | any of [string, null] | |
| extra_specs optional | Extra specs | any of [VolumeTypeExtraSpecs, null] | |
| id required | Volume type ID Example : c643ac35-3aec-43e6-b97a-3d6f666c5207 | string | |
| name optional | Volume type name Example : SSD | any of [string, null] |
4.2.136 - VolumeTypeExtraSpecs
| Name | Description | Schema | Default |
|---|---|---|---|
| multiattach optional | Multiattach Example : <is> True | any of [string, null] |
4.2.137 - VolumeTypeListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| volume_types required | Volume type list | array[VolumeTypeDetailResponse] |
4.2.138 - VolumeUpdateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| name optional | Volume name Example : volume01Pattern : ^[a-zA-Z0-9-_ ]*$ | any of [string, null] |
4.2.139 - VolumeV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| boot_index required | Defines the boot-device order. to disable a device from booting, set its index to None or a negative value. Example : 0 | integer | |
| delete_on_termination optional | Delete the boot volume when the server is terminated. Example : False | any of [boolean, null] | |
| max_iops optional | The number of distinct read or write operations a volume can process in a single second. Example : 10000 | any of [integer, null] | |
| max_throughput optional | The actual amount of data (volume) transferred to or from the storage device per second. Example : 500 | any of [integer, null] | |
| size required | Volume size, in gibibytes(GiB), must be multiple of 8. Example : 104 | integer | |
| source_type optional | Source type of volume. blank is empty volume with no pre-loaded data. image is volume from image. if source type is not set, it defaults to ‘image’ when boot_index is 0. otherwise it defaults to ‘blank’. Example : image | any of [enum (blank, image), null] | |
| type optional | Volume type Example : SSD | any of [string, null] |