This guide provides a brief description of Block Storage(BM) 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	20260531
1.1	DEPRECATED	20260331
1.0	DEPRECATED	20251231

OpenAPI URL

https://baremetal-blockstorage.{region}.{environment}.samsungsdscloud.com

Environment and Region List

environment	region
s	kr-west1
s	kr-east1
g	kr-south1
g	kr-south2
g	kr-south3
e	kr-west1
e	kr-east1

1 - APIs

1.1 - Add Volume Group Member on Volume Group

1.1.1 - 1.3

put /v1/volume-groups/{volume_group_id}/members/add

Description

Add Volume Group Member on Volume Group.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
body	body required		VolumeGroupMemberRequest

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/members/add

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-blockstorage 1.3"

Request body

{
    "volume_ids": [
        "13666d6c32d4456e8421f7768d0bf225"
    ]
}

Example HTTP response

Response 200

{
    "id": "c9ecae8b973b425c81c3817893cd8063",
    "member_volumes": [
        {
            "disk_type": "SSD",
            "id": "92cd16fe8ebc4f73832513a172bf0000",
            "name": "volume-01",
            "purpose": "ORG",
            "size_gb": 10,
            "so_volume_id": "",
            "so_volume_name": ""
        }
    ]
}

1.1.2 - 1.2

put /v1/volume-groups/{volume_group_id}/members/add

Description

Add Volume Group Member on Volume 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.2	20260531

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
body	body required		VolumeGroupMemberRequest

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/members/add

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

Request body

{
    "volume_ids": [
        "13666d6c32d4456e8421f7768d0bf225"
    ]
}

Example HTTP response

Response 200

{
    "id": "c9ecae8b973b425c81c3817893cd8063",
    "member_volumes": [
        {
            "disk_type": "SSD",
            "id": "92cd16fe8ebc4f73832513a172bf0000",
            "name": "volume-01",
            "purpose": "ORG",
            "size_gb": 10,
            "so_volume_id": "",
            "so_volume_name": ""
        }
    ]
}

1.1.3 - 1.1

put /v1/volume-groups/{volume_group_id}/members/add

Description

Add Volume Group Member on Volume 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	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
body	body required		VolumeGroupMemberRequest

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/members/add

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-blockstorage 1.1"

Request body

{
    "volume_ids": [
        "13666d6c32d4456e8421f7768d0bf225"
    ]
}

Example HTTP response

Response 200

{
    "id": "c9ecae8b973b425c81c3817893cd8063",
    "member_volumes": [
        {
            "disk_type": "SSD",
            "id": "92cd16fe8ebc4f73832513a172bf0000",
            "name": "volume-01",
            "purpose": "ORG",
            "size_gb": 10,
            "so_volume_id": "",
            "so_volume_name": ""
        }
    ]
}

1.1.4 - 1.0

put /v1/volume-groups/{volume_group_id}/members/add

Description

Add Volume Group Member on Volume 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	volume_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
body	body required		VolumeGroupMemberRequest

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/members/add

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-blockstorage 1.0"

Request body

{
    "volume_ids": [
        "13666d6c32d4456e8421f7768d0bf225"
    ]
}

Example HTTP response

Response 200

{
    "id": "c9ecae8b973b425c81c3817893cd8063",
    "member_volumes": [
        {
            "disk_type": "SSD",
            "id": "92cd16fe8ebc4f73832513a172bf0000",
            "name": "volume-01",
            "purpose": "ORG",
            "size_gb": 10,
            "so_volume_id": "",
            "so_volume_name": ""
        }
    ]
}

1.2 - Attach Volume

1.2.1 - 1.3

post /v1/volumes/{volume_id}/attachments

Description

Attach Volume to servers.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeAttachmentRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/attachments

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-blockstorage 1.3"

Request body

{
    "attachments": [
        {
            "object_id": "83c3c73d457345e3829ee6d5557c0016",
            "object_type": "BM"
        }
    ]
}

Example HTTP response

Response 200

{
    "attachments": [
        {
            "object_id": "83c3c73d457345e3829ee6d5557c0016",
            "object_type": "BM"
        }
    ]
}

1.2.2 - 1.2

post /v1/volumes/{volume_id}/attachments

Description

Attach Volume to 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.2	20260531

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeAttachmentRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/attachments

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

Request body

{
    "attachments": [
        {
            "object_id": "83c3c73d457345e3829ee6d5557c0016",
            "object_type": "BM"
        }
    ]
}

Example HTTP response

Response 200

{
    "attachments": [
        {
            "object_id": "83c3c73d457345e3829ee6d5557c0016",
            "object_type": "BM"
        }
    ]
}

1.2.3 - 1.1

post /v1/volumes/{volume_id}/attachments

Description

Attach Volume to 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	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeAttachmentRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/attachments

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-blockstorage 1.1"

Request body

{
    "attachments": [
        {
            "object_id": "83c3c73d457345e3829ee6d5557c0016",
            "object_type": "BM"
        }
    ]
}

Example HTTP response

Response 200

{
    "result": {
        "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
        "attachments": [
            {
                "id": "83c3c73d457345e3829ee6d5557c0011",
                "image_name": "RHEL 8.8 for BM",
                "name": "baremetal-01",
                "srn": "srn:dev2::36827d9b643f46c2ae6bb7e63d633bfe:kr-west1::baremetal-blockstorage:volume/97cd36e3c1984c8cad3ec193aeda25e0",
                "state": "RUNNING",
                "type": "BM"
            }
        ],
        "created_at": "2024-08-01T07:06:23.315Z",
        "created_by": "samsung-cloud-platform1@samsung.com",
        "disk_type": "SSD",
        "external_errors": [
            {
                "code": "Forbidden",
                "object_type": "BM",
                "status": 403
            }
        ],
        "has_origin": true,
        "has_replication": true,
        "id": "7239779c01e3405f82bb71c7f4b55fcd",
        "is_encryption": true,
        "iscsi_target_ips": [
            "172.30.4.3",
            "172.30.4.4"
        ],
        "modified_at": "2024-08-01T07:06:25.315Z",
        "modified_by": "samsung-cloud-platform2@samsung.com",
        "name": "bs-01",
        "previous_state": "CREATING",
        "purpose": "ORG",
        "recovery": {
            "origin_volume": {
                "attachments": [
                    {
                        "id": "83c3c73d457345e3829ee6d5557c0011",
                        "type": "BM"
                    }
                ],
                "id": "7239779c01e3405f82bb71c7f4b55fcd",
                "name": "bs-01"
            },
            "recovery_volume": {
                "attachments": [
                    {
                        "id": "83c3c73d457345e3829ee6d5557c0011",
                        "type": "BM"
                    }
                ],
                "id": "7239779c01e3405f82bb71c7f4b55fcd",
                "name": "bs-01"
            }
        },
        "size_gb": 10,
        "snapshot_rate": 100,
        "snapshot_schedule": {
            "day_of_week": "MON",
            "frequency": "DAILY",
            "hour": 18
        },
        "srn": "srn:dev2::36827d9b643f46c2ae6bb7e63d633bfe:kr-west1::baremetal-blockstorage:volume/97cd36e3c1984c8cad3ec193aeda25e0",
        "state": "CREATING",
        "storage_volume_name": "vo202407310544da8aadc775f",
        "volume_group": {
            "id": "7239779c01e3405f82bb71c7f4b55fcd",
            "name": "vg-01"
        }
    }
}

1.2.4 - 1.0

post /v1/volumes/{volume_id}/attachments

Description

Attach Volume to 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	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeAttachmentRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/attachments

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-blockstorage 1.0"

Request body

{
    "attachments": [
        {
            "object_id": "83c3c73d457345e3829ee6d5557c0016",
            "object_type": "BM"
        }
    ]
}

Example HTTP response

Response 200

{
    "result": {
        "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
        "attachments": [
            {
                "id": "83c3c73d457345e3829ee6d5557c0011",
                "image_name": "RHEL 8.8 for BM",
                "name": "baremetal-01",
                "srn": "srn:dev2::36827d9b643f46c2ae6bb7e63d633bfe:kr-west1::baremetal-blockstorage:volume/97cd36e3c1984c8cad3ec193aeda25e0",
                "state": "RUNNING",
                "type": "BM"
            }
        ],
        "created_at": "2024-08-01T07:06:23.315Z",
        "created_by": "samsung-cloud-platform1@samsung.com",
        "disk_type": "SSD",
        "external_errors": [
            {
                "code": "Forbidden",
                "object_type": "BM",
                "status": 403
            }
        ],
        "has_origin": true,
        "has_replication": true,
        "id": "7239779c01e3405f82bb71c7f4b55fcd",
        "is_encryption": true,
        "iscsi_target_ips": [
            "172.30.4.3",
            "172.30.4.4"
        ],
        "modified_at": "2024-08-01T07:06:25.315Z",
        "modified_by": "samsung-cloud-platform2@samsung.com",
        "name": "bs-01",
        "previous_state": "CREATING",
        "purpose": "ORG",
        "recovery": {
            "origin_volume": {
                "attachments": [
                    {
                        "id": "83c3c73d457345e3829ee6d5557c0011",
                        "type": "BM"
                    }
                ],
                "id": "7239779c01e3405f82bb71c7f4b55fcd",
                "name": "bs-01"
            },
            "recovery_volume": {
                "attachments": [
                    {
                        "id": "83c3c73d457345e3829ee6d5557c0011",
                        "type": "BM"
                    }
                ],
                "id": "7239779c01e3405f82bb71c7f4b55fcd",
                "name": "bs-01"
            }
        },
        "size_gb": 10,
        "snapshot_rate": 100,
        "snapshot_schedule": {
            "day_of_week": "MON",
            "frequency": "DAILY",
            "hour": 18
        },
        "srn": "srn:dev2::36827d9b643f46c2ae6bb7e63d633bfe:kr-west1::baremetal-blockstorage:volume/97cd36e3c1984c8cad3ec193aeda25e0",
        "state": "CREATING",
        "storage_volume_name": "vo202407310544da8aadc775f",
        "volume_group": {
            "id": "7239779c01e3405f82bb71c7f4b55fcd",
            "name": "vg-01"
        }
    }
}

1.3 - Create Volume

1.3.1 - 1.3

post /v1/volumes

Description

Create Volume.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
body	body required		VolumeCreateRequestV1Dot2

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	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 = baremetal-blockstorage 1.3"

Request body

{
    "attachments": [
        {
            "object_id": "83c3c73d457345e3829ee6d5557c0016",
            "object_type": "BM"
        }
    ],
    "disk_type": "SSD",
    "name": "bs-01",
    "qos": {
        "iops": 5000,
        "throughput": 250
    },
    "size_gb": 10,
    "tags": [
        {
            "key": "my_tag_1",
            "value": "my_value_1"
        }
    ]
}

Example HTTP response

Response 202

{
    "request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
    "resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}

1.3.2 - 1.2

post /v1/volumes

Description

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

Parameters

Type	Name	Description	Schema	Default
body	body required		VolumeCreateRequestV1Dot2

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/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 = baremetal-blockstorage 1.2"

Request body

{
    "attachments": [
        {
            "object_id": "83c3c73d457345e3829ee6d5557c0016",
            "object_type": "BM"
        }
    ],
    "disk_type": "SSD",
    "name": "bs-01",
    "qos": {
        "iops": 5000,
        "throughput": 250
    },
    "size_gb": 10,
    "tags": [
        {
            "key": "my_tag_1",
            "value": "my_value_1"
        }
    ]
}

Example HTTP response

Response 202

{
    "request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
    "resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}

1.3.3 - 1.1

post /v1/volumes

Description

Create 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	20260331

Parameters

Type	Name	Description	Schema	Default
body	body required		VolumeCreateRequest

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/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 = baremetal-blockstorage 1.1"

Request body

{
    "attachments": [
        {
            "object_id": "83c3c73d457345e3829ee6d5557c0016",
            "object_type": "BM"
        }
    ],
    "disk_type": "SSD",
    "name": "bs-01",
    "size_gb": 10,
    "tags": [
        {
            "key": "my_tag_1",
            "value": "my_value_1"
        }
    ]
}

Example HTTP response

Response 202

{
    "request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
    "resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}

1.3.4 - 1.0

post /v1/volumes

Description

Create 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	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	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 = baremetal-blockstorage 1.0"

Request body

{
    "attachments": [
        {
            "object_id": "83c3c73d457345e3829ee6d5557c0016",
            "object_type": "BM"
        }
    ],
    "disk_type": "SSD",
    "name": "bs-01",
    "size_gb": 10,
    "tags": [
        {
            "key": "my_tag_1",
            "value": "my_value_1"
        }
    ]
}

Example HTTP response

Response 202

{
    "request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
    "resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}

1.4 - Create Volume Group

1.4.1 - 1.3

post /v1/volume-groups

Description

Create Volume Group

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
body	body required		VolumeGroupCreationRequest

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/volume-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 = baremetal-blockstorage 1.3"

Request body

{
    "name": "vg-01",
    "tags": [
        {
            "key": "my_tag_1",
            "value": "my_value_1"
        }
    ],
    "volume_ids": [
        "17e0b4fd27784dfb843440ec08bdd148"
    ]
}

Example HTTP response

Response 202

{
    "request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
    "resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}

1.4.2 - 1.2

post /v1/volume-groups

Description

Create Volume 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.2	20260531

Parameters

Type	Name	Description	Schema	Default
body	body required		VolumeGroupCreationRequest

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/volume-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 = baremetal-blockstorage 1.2"

Request body

{
    "name": "vg-01",
    "tags": [
        {
            "key": "my_tag_1",
            "value": "my_value_1"
        }
    ],
    "volume_ids": [
        "17e0b4fd27784dfb843440ec08bdd148"
    ]
}

Example HTTP response

Response 202

{
    "request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
    "resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}

1.4.3 - 1.1

post /v1/volume-groups

Description

Create Volume 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	20260331

Parameters

Type	Name	Description	Schema	Default
body	body required		VolumeGroupCreationRequest

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/volume-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 = baremetal-blockstorage 1.1"

Request body

{
    "name": "vg-01",
    "tags": [
        {
            "key": "my_tag_1",
            "value": "my_value_1"
        }
    ],
    "volume_ids": [
        "17e0b4fd27784dfb843440ec08bdd148"
    ]
}

Example HTTP response

Response 202

{
    "request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
    "resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}

1.4.4 - 1.0

post /v1/volume-groups

Description

Create Volume 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		VolumeGroupCreationRequest

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/volume-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 = baremetal-blockstorage 1.0"

Request body

{
    "name": "vg-01",
    "tags": [
        {
            "key": "my_tag_1",
            "value": "my_value_1"
        }
    ],
    "volume_ids": [
        "17e0b4fd27784dfb843440ec08bdd148"
    ]
}

Example HTTP response

Response 202

{
    "request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
    "resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}

1.5 - Create Volume Group Recovery

1.5.1 - 1.3

post /v1/volume-groups/{volume_group_id}/recoveries

Description

Create Volume Group Recovery.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
body	body required		VolumeGroupRecoveryCreateRequest

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/volume-groups/{volume_group_id}/recoveries

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-blockstorage 1.3"

Request body

{
    "block_storage_name_prefix": "prefix-",
    "snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501"
}

Example HTTP response

Response 202

{
    "request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
    "resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}

1.5.2 - 1.2

post /v1/volume-groups/{volume_group_id}/recoveries

Description

Create Volume Group Recovery.

State ACTIVE (DEPRECATED)

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

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
body	body required		VolumeGroupRecoveryCreateRequest

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/volume-groups/{volume_group_id}/recoveries

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

Request body

{
    "block_storage_name_prefix": "prefix-",
    "snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501"
}

Example HTTP response

Response 202

{
    "request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
    "resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}

1.5.3 - 1.1

post /v1/volume-groups/{volume_group_id}/recoveries

Description

Create Volume Group Recovery.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
body	body required		VolumeGroupRecoveryCreateRequest

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/volume-groups/{volume_group_id}/recoveries

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-blockstorage 1.1"

Request body

{
    "block_storage_name_prefix": "prefix-",
    "snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501"
}

Example HTTP response

Response 202

{
    "request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
    "resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}

1.6 - Create Volume Group Replication

1.6.1 - 1.3

post /v1/volume-groups/{volume_group_id}/replications

Description

Create Volume Group Replication.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
body	body required		VolumeGroupReplicationCreateRequest

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/volume-groups/{volume_group_id}/replications

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-blockstorage 1.3"

Request body

{
    "cycle": "5MIN",
    "name": "replica-vg-01",
    "region": "kr-west1",
    "replication_volume_name_prefix": "dr"
}

Example HTTP response

Response 202

{
    "request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
    "resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}

1.6.2 - 1.2

post /v1/volume-groups/{volume_group_id}/replications

Description

Create Volume Group Replication.

State ACTIVE (DEPRECATED)

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

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
body	body required		VolumeGroupReplicationCreateRequest

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/volume-groups/{volume_group_id}/replications

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

Request body

{
    "cycle": "5MIN",
    "name": "replica-vg-01",
    "region": "kr-west1",
    "replication_volume_name_prefix": "dr"
}

Example HTTP response

Response 202

{
    "request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
    "resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}

1.6.3 - 1.1

post /v1/volume-groups/{volume_group_id}/replications

Description

Create Volume Group Replication.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
body	body required		VolumeGroupReplicationCreateRequest

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/volume-groups/{volume_group_id}/replications

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-blockstorage 1.1"

Request body

{
    "cycle": "5MIN",
    "name": "replica-vg-01",
    "region": "kr-west1",
    "replication_volume_name_prefix": "dr"
}

Example HTTP response

Response 202

{
    "request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
    "resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}

1.6.4 - 1.0

post /v1/volume-groups/{volume_group_id}/replications

Description

Create Volume Group Replication.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or 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_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
body	body required		VolumeGroupReplicationCreateRequest

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/volume-groups/{volume_group_id}/replications

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-blockstorage 1.0"

Request body

{
    "cycle": "5MIN",
    "name": "replica-vg-01",
    "region": "kr-west1",
    "replication_volume_name_prefix": "dr"
}

Example HTTP response

Response 202

{
    "request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
    "resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}

1.7 - Create Volume Group Snapshot

1.7.1 - 1.3

post /v1/volume-groups/{volume_group_id}/snapshots

Description

Create Volume Group Snapshot

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/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 = baremetal-blockstorage 1.3"

Example HTTP response

Response 200

{
    "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
    "snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501",
    "snapshot_name": "vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932",
    "volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}

1.7.2 - 1.2

post /v1/volume-groups/{volume_group_id}/snapshots

Description

Create Volume Group 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.2	20260531

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/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 = baremetal-blockstorage 1.2"

Example HTTP response

Response 200

{
    "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
    "snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501",
    "snapshot_name": "vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932",
    "volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}

1.7.3 - 1.1

post /v1/volume-groups/{volume_group_id}/snapshots

Description

Create Volume Group 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	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/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 = baremetal-blockstorage 1.1"

Example HTTP response

Response 200

{
    "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
    "snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501",
    "snapshot_name": "vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932",
    "volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}

1.7.4 - 1.0

post /v1/volume-groups/{volume_group_id}/snapshots

Description

Create Volume Group 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	volume_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/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 = baremetal-blockstorage 1.0"

Example HTTP response

Response 200

{
    "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
    "snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501",
    "snapshot_name": "vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932",
    "volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}

1.8 - Create Volume Group Snapshot Schedule

1.8.1 - 1.3

post /v1/volume-groups/{volume_group_id}/snapshot-schedules

Description

Create Volume Group Snapshot Schedule.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
body	body required		VolumeGroupSnapshotScheduleRequest

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/snapshot-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 = baremetal-blockstorage 1.3"

Request body

{
    "day_of_week": "SUN",
    "hour": 18
}

Example HTTP response

Response 200

{
    "day_of_week": "SUN",
    "frequency": "DAILY",
    "hour": 18,
    "volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}

1.8.2 - 1.2

post /v1/volume-groups/{volume_group_id}/snapshot-schedules

Description

Create Volume Group Snapshot 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.2	20260531

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
body	body required		VolumeGroupSnapshotScheduleRequest

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/snapshot-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 = baremetal-blockstorage 1.2"

Request body

{
    "day_of_week": "SUN",
    "hour": 18
}

Example HTTP response

Response 200

{
    "day_of_week": "SUN",
    "frequency": "DAILY",
    "hour": 18,
    "volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}

1.8.3 - 1.1

post /v1/volume-groups/{volume_group_id}/snapshot-schedules

Description

Create Volume Group Snapshot 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	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
body	body required		VolumeGroupSnapshotScheduleRequest

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/snapshot-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 = baremetal-blockstorage 1.1"

Request body

{
    "day_of_week": "SUN",
    "hour": 18
}

Example HTTP response

Response 200

{
    "day_of_week": "SUN",
    "frequency": "DAILY",
    "hour": 18,
    "volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}

1.8.4 - 1.0

post /v1/volume-groups/{volume_group_id}/snapshot-schedules

Description

Create Volume Group Snapshot 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	volume_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
body	body required		VolumeGroupSnapshotScheduleRequest

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/snapshot-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 = baremetal-blockstorage 1.0"

Request body

{
    "day_of_week": "SUN",
    "hour": 18
}

Example HTTP response

Response 200

{
    "day_of_week": "SUN",
    "frequency": "DAILY",
    "hour": 18,
    "volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}

1.9 - Create Volume Recovery

1.9.1 - 1.3

post /v1/volumes/{volume_id}/recoveries

Description

Create Volume Recovery.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeRecoveryCreateRequest

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/volumes/{volume_id}/recoveries

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-blockstorage 1.3"

Request body

{
    "name": "recovery-volume",
    "snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501"
}

Example HTTP response

Response 202

{
    "request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
    "resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}

1.9.2 - 1.2

post /v1/volumes/{volume_id}/recoveries

Description

Create Volume Recovery.

State ACTIVE (DEPRECATED)

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

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeRecoveryCreateRequest

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/volumes/{volume_id}/recoveries

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

Request body

{
    "name": "recovery-volume",
    "snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501"
}

Example HTTP response

Response 202

{
    "request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
    "resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}

1.9.3 - 1.1

post /v1/volumes/{volume_id}/recoveries

Description

Create Volume Recovery.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeRecoveryCreateRequest

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/volumes/{volume_id}/recoveries

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-blockstorage 1.1"

Request body

{
    "name": "recovery-volume",
    "snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501"
}

Example HTTP response

Response 202

{
    "request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
    "resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}

1.10 - Create Volume Replication

1.10.1 - 1.3

post /v1/volumes/{volume_id}/replications

Description

Create Volume Replication.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeReplicationCreateRequest

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/volumes/{volume_id}/replications

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-blockstorage 1.3"

Request body

{
    "cycle": "5MIN",
    "name": "replica-bs-01",
    "region": "kr-west1"
}

Example HTTP response

Response 202

{
    "request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
    "resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}

1.10.2 - 1.2

post /v1/volumes/{volume_id}/replications

Description

Create Volume Replication.

State ACTIVE (DEPRECATED)

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

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeReplicationCreateRequest

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/volumes/{volume_id}/replications

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

Request body

{
    "cycle": "5MIN",
    "name": "replica-bs-01",
    "region": "kr-west1"
}

Example HTTP response

Response 202

{
    "request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
    "resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}

1.10.3 - 1.1

post /v1/volumes/{volume_id}/replications

Description

Create Volume Replication.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeReplicationCreateRequest

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/volumes/{volume_id}/replications

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-blockstorage 1.1"

Request body

{
    "cycle": "5MIN",
    "name": "replica-bs-01",
    "region": "kr-west1"
}

Example HTTP response

Response 202

{
    "request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
    "resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}

1.10.4 - 1.0

post /v1/volumes/{volume_id}/replications

Description

Create Volume Replication.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or 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 : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeReplicationCreateRequest

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/volumes/{volume_id}/replications

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-blockstorage 1.0"

Request body

{
    "cycle": "5MIN",
    "name": "replica-bs-01",
    "region": "kr-west1"
}

Example HTTP response

Response 202

{
    "request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
    "resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}

1.11 - Create Volume Snapshot

1.11.1 - 1.3

post /v1/volumes/{volume_id}/snapshots

Description

Create Volume snapshot.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/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 = baremetal-blockstorage 1.3"

Example HTTP response

Response 200

{
    "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
    "snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501",
    "snapshot_name": "vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932",
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

1.11.2 - 1.2

post /v1/volumes/{volume_id}/snapshots

Description

Create Volume 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.2	20260531

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/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 = baremetal-blockstorage 1.2"

Example HTTP response

Response 200

{
    "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
    "snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501",
    "snapshot_name": "vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932",
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

1.11.3 - 1.1

post /v1/volumes/{volume_id}/snapshots

Description

Create Volume 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	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/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 = baremetal-blockstorage 1.1"

Example HTTP response

Response 200

{
    "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
    "snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501",
    "snapshot_name": "vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932",
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

1.11.4 - 1.0

post /v1/volumes/{volume_id}/snapshots

Description

Create Volume 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	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/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 = baremetal-blockstorage 1.0"

Example HTTP response

Response 200

{
    "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
    "snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501",
    "snapshot_name": "vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932",
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

1.12 - Create Volume Snapshot Rate

1.12.1 - 1.3

post /v1/volumes/{volume_id}/snapshot-rates

Description

Create Volume snapshot rate.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeSnapshotRateRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/snapshot-rates

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-blockstorage 1.3"

Request body

{
    "snapshot_rate": 100
}

Example HTTP response

Response 200

{
    "is_snapshot_activated": true,
    "snapshot_rate": 100,
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

1.12.2 - 1.2

post /v1/volumes/{volume_id}/snapshot-rates

Description

Create Volume snapshot rate.

State ACTIVE (DEPRECATED)

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

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeSnapshotRateRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/snapshot-rates

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

Request body

{
    "snapshot_rate": 100
}

Example HTTP response

Response 200

{
    "is_snapshot_activated": true,
    "snapshot_rate": 100,
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

1.12.3 - 1.1

post /v1/volumes/{volume_id}/snapshot-rates

Description

Create Volume snapshot rate.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeSnapshotRateRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/snapshot-rates

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-blockstorage 1.1"

Request body

{
    "snapshot_rate": 100
}

Example HTTP response

Response 200

{
    "is_snapshot_activated": true,
    "snapshot_rate": 100,
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

1.12.4 - 1.0

post /v1/volumes/{volume_id}/snapshot-rates

Description

Create Volume snapshot rate.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or 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 : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeSnapshotRateRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/snapshot-rates

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-blockstorage 1.0"

Request body

{
    "snapshot_rate": 100
}

Example HTTP response

Response 200

{
    "is_snapshot_activated": true,
    "snapshot_rate": 100,
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

1.13 - Create Volume Snapshot Schedule

1.13.1 - 1.3

post /v1/volumes/{volume_id}/snapshot-schedules

Description

Create Volume snapshot schedule.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeSnapshotScheduleRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/snapshot-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 = baremetal-blockstorage 1.3"

Request body

{
    "day_of_week": "SUN",
    "hour": 18
}

Example HTTP response

Response 200

{
    "day_of_week": "",
    "frequency": "DAILY",
    "hour": 18,
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

1.13.2 - 1.2

post /v1/volumes/{volume_id}/snapshot-schedules

Description

Create Volume snapshot 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.2	20260531

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeSnapshotScheduleRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/snapshot-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 = baremetal-blockstorage 1.2"

Request body

{
    "day_of_week": "SUN",
    "hour": 18
}

Example HTTP response

Response 200

{
    "day_of_week": "",
    "frequency": "DAILY",
    "hour": 18,
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

1.13.3 - 1.1

post /v1/volumes/{volume_id}/snapshot-schedules

Description

Create Volume snapshot 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	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeSnapshotScheduleRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/snapshot-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 = baremetal-blockstorage 1.1"

Request body

{
    "day_of_week": "SUN",
    "hour": 18
}

Example HTTP response

Response 200

{
    "day_of_week": "",
    "frequency": "DAILY",
    "hour": 18,
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

1.13.4 - 1.0

post /v1/volumes/{volume_id}/snapshot-schedules

Description

Create Volume snapshot 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	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeSnapshotScheduleRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/snapshot-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 = baremetal-blockstorage 1.0"

Request body

{
    "day_of_week": "SUN",
    "hour": 18
}

Example HTTP response

Response 200

{
    "day_of_week": "",
    "frequency": "DAILY",
    "hour": 18,
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

1.14 - Delete Volume

1.14.1 - 1.3

delete /v1/volumes/{volume_id}

Description

Delete Volume.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None

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/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 = baremetal-blockstorage 1.3"

Example HTTP response

Response 202

{
    "request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
    "resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}

1.14.2 - 1.2

delete /v1/volumes/{volume_id}

Description

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

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None

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/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 = baremetal-blockstorage 1.2"

Example HTTP response

Response 202

{
    "request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
    "resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}

1.14.3 - 1.1

delete /v1/volumes/{volume_id}

Description

Delete 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	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None

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/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 = baremetal-blockstorage 1.1"

Example HTTP response

Response 202

{
    "request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
    "resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}

1.14.4 - 1.0

delete /v1/volumes/{volume_id}

Description

Delete 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 : `92cd16fe8ebc4f73832513a172bf0000`	string	None

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/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 = baremetal-blockstorage 1.0"

Example HTTP response

Response 202

{
    "request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
    "resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}

1.15 - Delete Volume Group Replication

1.15.1 - 1.3

delete /v1/volume-groups/{volume_group_id}/replications

Description

Delete Volume Group Replication.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/replications

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-blockstorage 1.3"

Example HTTP response

Response 200

{
    "result": ""
}

1.15.2 - 1.2

delete /v1/volume-groups/{volume_group_id}/replications

Description

Delete Volume Group Replication.

State ACTIVE (DEPRECATED)

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

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/replications

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

Example HTTP response

Response 200

{
    "result": ""
}

1.15.3 - 1.1

delete /v1/volume-groups/{volume_group_id}/replications

Description

Delete Volume Group Replication.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/replications

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-blockstorage 1.1"

Example HTTP response

Response 200

{
    "result": ""
}

1.15.4 - 1.0

delete /v1/volume-groups/{volume_group_id}/replications

Description

Delete Volume Group Replication.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or 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_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/replications

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-blockstorage 1.0"

Example HTTP response

Response 200

{
    "result": ""
}

1.16 - Delete Volume Group Snapshot

1.16.1 - 1.3

delete /v1/volume-groups/{volume_group_id}/snapshots/{snapshot_id}

Description

Delete Volume Group snapshot.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
path	snapshot_id required	Snapshot id Example : `05600123-6e78-11f0-a3f0-d039eab8d501`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/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 = baremetal-blockstorage 1.3"

Example HTTP response

Response 200

{
    "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
    "snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501",
    "volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}

1.16.2 - 1.2

delete /v1/volume-groups/{volume_group_id}/snapshots/{snapshot_id}

Description

Delete Volume Group 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.2	20260531

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
path	snapshot_id required	Snapshot id Example : `05600123-6e78-11f0-a3f0-d039eab8d501`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/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 = baremetal-blockstorage 1.2"

Example HTTP response

Response 200

{
    "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
    "snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501",
    "volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}

1.16.3 - 1.1

delete /v1/volume-groups/{volume_group_id}/snapshots/{snapshot_id}

Description

Delete Volume Group 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	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
path	snapshot_id required	Snapshot id Example : `05600123-6e78-11f0-a3f0-d039eab8d501`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/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 = baremetal-blockstorage 1.1"

Example HTTP response

Response 200

{
    "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
    "snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501",
    "volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}

1.16.4 - 1.0

delete /v1/volume-groups/{volume_group_id}/snapshots/{snapshot_id}

Description

Delete Volume Group 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	volume_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
path	snapshot_id required	Snapshot id Example : `05600123-6e78-11f0-a3f0-d039eab8d501`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/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 = baremetal-blockstorage 1.0"

Example HTTP response

Response 200

{
    "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
    "snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501",
    "volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}

1.17 - Delete Volume Group Snapshot Schedule

1.17.1 - 1.3

delete /v1/volume-groups/{volume_group_id}/snapshot-schedules

Description

Delete Volume Group Snapshot Schedule.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/snapshot-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 = baremetal-blockstorage 1.3"

Example HTTP response

Response 200

{
    "day_of_week": "SUN",
    "frequency": "DAILY",
    "hour": 18,
    "volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}

1.17.2 - 1.2

delete /v1/volume-groups/{volume_group_id}/snapshot-schedules

Description

Delete Volume Group Snapshot 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.2	20260531

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/snapshot-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 = baremetal-blockstorage 1.2"

Example HTTP response

Response 200

{
    "day_of_week": "SUN",
    "frequency": "DAILY",
    "hour": 18,
    "volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}

1.17.3 - 1.1

delete /v1/volume-groups/{volume_group_id}/snapshot-schedules

Description

Delete Volume Group Snapshot 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	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/snapshot-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 = baremetal-blockstorage 1.1"

Example HTTP response

Response 200

{
    "day_of_week": "SUN",
    "frequency": "DAILY",
    "hour": 18,
    "volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}

1.17.4 - 1.0

delete /v1/volume-groups/{volume_group_id}/snapshot-schedules

Description

Delete Volume Group Snapshot 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	volume_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/snapshot-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 = baremetal-blockstorage 1.0"

Example HTTP response

Response 200

{
    "day_of_week": "SUN",
    "frequency": "DAILY",
    "hour": 18,
    "volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}

1.18 - Delete Volume Replication

1.18.1 - 1.3

delete /v1/volumes/{volume_id}/replications

Description

Delete Volume Replication.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None

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/volumes/{volume_id}/replications

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-blockstorage 1.3"

Example HTTP response

Response 202

{
    "request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
    "resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}

1.18.2 - 1.2

delete /v1/volumes/{volume_id}/replications

Description

Delete Volume Replication.

State ACTIVE (DEPRECATED)

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

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None

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/volumes/{volume_id}/replications

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

Example HTTP response

Response 202

{
    "request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
    "resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}

1.18.3 - 1.1

delete /v1/volumes/{volume_id}/replications

Description

Delete Volume Replication.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None

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/volumes/{volume_id}/replications

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-blockstorage 1.1"

Example HTTP response

Response 202

{
    "request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
    "resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}

1.18.4 - 1.0

delete /v1/volumes/{volume_id}/replications

Description

Delete Volume Replication.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or 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 : `92cd16fe8ebc4f73832513a172bf0000`	string	None

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/volumes/{volume_id}/replications

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-blockstorage 1.0"

Example HTTP response

Response 202

{
    "request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
    "resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}

1.19 - Delete Volume Snapshot

1.19.1 - 1.3

delete /v1/volumes/{volume_id}/snapshots/{snapshot_id}

Description

Delete Volume snapshot.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
path	snapshot_id required	Snapshot id Example : `05600123-6e78-11f0-a3f0-d039eab8d501`	string	None

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/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 = baremetal-blockstorage 1.3"

Example HTTP response

Response 200

{
    "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
    "snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501",
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

1.19.2 - 1.2

delete /v1/volumes/{volume_id}/snapshots/{snapshot_id}

Description

Delete Volume 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.2	20260531

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
path	snapshot_id required	Snapshot id Example : `05600123-6e78-11f0-a3f0-d039eab8d501`	string	None

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/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 = baremetal-blockstorage 1.2"

Example HTTP response

Response 200

{
    "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
    "snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501",
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

1.19.3 - 1.1

delete /v1/volumes/{volume_id}/snapshots/{snapshot_id}

Description

Delete Volume 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	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
path	snapshot_id required	Snapshot id Example : `05600123-6e78-11f0-a3f0-d039eab8d501`	string	None

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/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 = baremetal-blockstorage 1.1"

Example HTTP response

Response 200

{
    "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
    "snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501",
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

1.19.4 - 1.0

delete /v1/volumes/{volume_id}/snapshots/{snapshot_id}

Description

Delete Volume 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	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
path	snapshot_id required	Snapshot id Example : `05600123-6e78-11f0-a3f0-d039eab8d501`	string	None

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/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 = baremetal-blockstorage 1.0"

Example HTTP response

Response 200

{
    "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
    "snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501",
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

1.20 - Delete Volume Snapshot Rate

1.20.1 - 1.3

delete /v1/volumes/{volume_id}/snapshot-rates

Description

Delete Volume snapshot rate.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/snapshot-rates

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-blockstorage 1.3"

Example HTTP response

Response 200

{
    "is_snapshot_activated": true,
    "snapshot_rate": 100,
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

1.20.2 - 1.2

delete /v1/volumes/{volume_id}/snapshot-rates

Description

Delete Volume snapshot rate.

State ACTIVE (DEPRECATED)

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

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/snapshot-rates

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

Example HTTP response

Response 200

{
    "is_snapshot_activated": true,
    "snapshot_rate": 100,
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

1.20.3 - 1.1

delete /v1/volumes/{volume_id}/snapshot-rates

Description

Delete Volume snapshot rate.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/snapshot-rates

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-blockstorage 1.1"

Example HTTP response

Response 200

{
    "is_snapshot_activated": true,
    "snapshot_rate": 100,
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

1.20.4 - 1.0

delete /v1/volumes/{volume_id}/snapshot-rates

Description

Delete Volume snapshot rate.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or 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 : `92cd16fe8ebc4f73832513a172bf0000`	string	None

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/snapshot-rates

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-blockstorage 1.0"

Example HTTP response

Response 200

{
    "is_snapshot_activated": true,
    "snapshot_rate": 100,
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

1.21 - Delete Volume Snapshot Schedule

1.21.1 - 1.3

delete /v1/volumes/{volume_id}/snapshot-schedules

Description

Delete Volume snapshot schedule.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/snapshot-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 = baremetal-blockstorage 1.3"

Example HTTP response

Response 200

{
    "day_of_week": "",
    "frequency": "DAILY",
    "hour": 18,
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

1.21.2 - 1.2

delete /v1/volumes/{volume_id}/snapshot-schedules

Description

Delete Volume snapshot 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.2	20260531

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/snapshot-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 = baremetal-blockstorage 1.2"

Example HTTP response

Response 200

{
    "day_of_week": "",
    "frequency": "DAILY",
    "hour": 18,
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

1.21.3 - 1.1

delete /v1/volumes/{volume_id}/snapshot-schedules

Description

Delete Volume snapshot 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	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/snapshot-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 = baremetal-blockstorage 1.1"

Example HTTP response

Response 200

{
    "day_of_week": "",
    "frequency": "DAILY",
    "hour": 18,
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

1.21.4 - 1.0

delete /v1/volumes/{volume_id}/snapshot-schedules

Description

Delete Volume snapshot 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	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/snapshot-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 = baremetal-blockstorage 1.0"

Example HTTP response

Response 200

{
    "day_of_week": "",
    "frequency": "DAILY",
    "hour": 18,
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

1.22 - Detach Volume

1.22.1 - 1.3

delete /v1/volumes/{volume_id}/attachments

Description

Detach Volume from servers.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeDetachRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/attachments

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-blockstorage 1.3"

Request body

{
    "attachments": [
        ""
    ]
}

Example HTTP response

Response 200

{
    "attachments": [
        {
            "object_id": "83c3c73d457345e3829ee6d5557c0016",
            "object_type": "BM"
        }
    ]
}

1.22.2 - 1.2

delete /v1/volumes/{volume_id}/attachments

Description

Detach Volume from 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.2	20260531

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeDetachRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/attachments

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

Request body

{
    "attachments": [
        ""
    ]
}

Example HTTP response

Response 200

{
    "attachments": [
        {
            "object_id": "83c3c73d457345e3829ee6d5557c0016",
            "object_type": "BM"
        }
    ]
}

1.22.3 - 1.1

delete /v1/volumes/{volume_id}/attachments

Description

Detach Volume from 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	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeDetachRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/attachments

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-blockstorage 1.1"

Request body

{
    "attachments": [
        ""
    ]
}

Example HTTP response

Response 200

{
    "result": {
        "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
        "attachments": [
            {
                "id": "83c3c73d457345e3829ee6d5557c0011",
                "image_name": "RHEL 8.8 for BM",
                "name": "baremetal-01",
                "srn": "srn:dev2::36827d9b643f46c2ae6bb7e63d633bfe:kr-west1::baremetal-blockstorage:volume/97cd36e3c1984c8cad3ec193aeda25e0",
                "state": "RUNNING",
                "type": "BM"
            }
        ],
        "created_at": "2024-08-01T07:06:23.315Z",
        "created_by": "samsung-cloud-platform1@samsung.com",
        "disk_type": "SSD",
        "external_errors": [
            {
                "code": "Forbidden",
                "object_type": "BM",
                "status": 403
            }
        ],
        "has_origin": true,
        "has_replication": true,
        "id": "7239779c01e3405f82bb71c7f4b55fcd",
        "is_encryption": true,
        "iscsi_target_ips": [
            "172.30.4.3",
            "172.30.4.4"
        ],
        "modified_at": "2024-08-01T07:06:25.315Z",
        "modified_by": "samsung-cloud-platform2@samsung.com",
        "name": "bs-01",
        "previous_state": "CREATING",
        "purpose": "ORG",
        "recovery": {
            "origin_volume": {
                "attachments": [
                    {
                        "id": "83c3c73d457345e3829ee6d5557c0011",
                        "type": "BM"
                    }
                ],
                "id": "7239779c01e3405f82bb71c7f4b55fcd",
                "name": "bs-01"
            },
            "recovery_volume": {
                "attachments": [
                    {
                        "id": "83c3c73d457345e3829ee6d5557c0011",
                        "type": "BM"
                    }
                ],
                "id": "7239779c01e3405f82bb71c7f4b55fcd",
                "name": "bs-01"
            }
        },
        "size_gb": 10,
        "snapshot_rate": 100,
        "snapshot_schedule": {
            "day_of_week": "MON",
            "frequency": "DAILY",
            "hour": 18
        },
        "srn": "srn:dev2::36827d9b643f46c2ae6bb7e63d633bfe:kr-west1::baremetal-blockstorage:volume/97cd36e3c1984c8cad3ec193aeda25e0",
        "state": "CREATING",
        "storage_volume_name": "vo202407310544da8aadc775f",
        "volume_group": {
            "id": "7239779c01e3405f82bb71c7f4b55fcd",
            "name": "vg-01"
        }
    }
}

1.22.4 - 1.0

delete /v1/volumes/{volume_id}/attachments

Description

Detach Volume from 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	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeDetachRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/attachments

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-blockstorage 1.0"

Request body

{
    "attachments": [
        ""
    ]
}

Example HTTP response

Response 200

{
    "result": {
        "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
        "attachments": [
            {
                "id": "83c3c73d457345e3829ee6d5557c0011",
                "image_name": "RHEL 8.8 for BM",
                "name": "baremetal-01",
                "srn": "srn:dev2::36827d9b643f46c2ae6bb7e63d633bfe:kr-west1::baremetal-blockstorage:volume/97cd36e3c1984c8cad3ec193aeda25e0",
                "state": "RUNNING",
                "type": "BM"
            }
        ],
        "created_at": "2024-08-01T07:06:23.315Z",
        "created_by": "samsung-cloud-platform1@samsung.com",
        "disk_type": "SSD",
        "external_errors": [
            {
                "code": "Forbidden",
                "object_type": "BM",
                "status": 403
            }
        ],
        "has_origin": true,
        "has_replication": true,
        "id": "7239779c01e3405f82bb71c7f4b55fcd",
        "is_encryption": true,
        "iscsi_target_ips": [
            "172.30.4.3",
            "172.30.4.4"
        ],
        "modified_at": "2024-08-01T07:06:25.315Z",
        "modified_by": "samsung-cloud-platform2@samsung.com",
        "name": "bs-01",
        "previous_state": "CREATING",
        "purpose": "ORG",
        "recovery": {
            "origin_volume": {
                "attachments": [
                    {
                        "id": "83c3c73d457345e3829ee6d5557c0011",
                        "type": "BM"
                    }
                ],
                "id": "7239779c01e3405f82bb71c7f4b55fcd",
                "name": "bs-01"
            },
            "recovery_volume": {
                "attachments": [
                    {
                        "id": "83c3c73d457345e3829ee6d5557c0011",
                        "type": "BM"
                    }
                ],
                "id": "7239779c01e3405f82bb71c7f4b55fcd",
                "name": "bs-01"
            }
        },
        "size_gb": 10,
        "snapshot_rate": 100,
        "snapshot_schedule": {
            "day_of_week": "MON",
            "frequency": "DAILY",
            "hour": 18
        },
        "srn": "srn:dev2::36827d9b643f46c2ae6bb7e63d633bfe:kr-west1::baremetal-blockstorage:volume/97cd36e3c1984c8cad3ec193aeda25e0",
        "state": "CREATING",
        "storage_volume_name": "vo202407310544da8aadc775f",
        "volume_group": {
            "id": "7239779c01e3405f82bb71c7f4b55fcd",
            "name": "vg-01"
        }
    }
}

1.23 - List Volume Group Snapshots

1.23.1 - 1.3

get /v1/volume-groups/{volume_group_id}/snapshots

Description

Get a list of Volume Group snapshots.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/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 = baremetal-blockstorage 1.3"

Example HTTP response

Response 200

{
    "is_snapshot_policy": false,
    "snapshots": [],
    "volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}

1.23.2 - 1.2

get /v1/volume-groups/{volume_group_id}/snapshots

Description

Get a list of Volume Group 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.2	20260531

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/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 = baremetal-blockstorage 1.2"

Example HTTP response

Response 200

{
    "is_snapshot_policy": false,
    "snapshots": [],
    "volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}

1.23.3 - 1.1

get /v1/volume-groups/{volume_group_id}/snapshots

Description

Get a list of Volume Group 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	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/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 = baremetal-blockstorage 1.1"

Example HTTP response

Response 200

{
    "is_snapshot_policy": false,
    "snapshots": [],
    "volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}

1.23.4 - 1.0

get /v1/volume-groups/{volume_group_id}/snapshots

Description

Get a list of Volume Group 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
path	volume_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/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 = baremetal-blockstorage 1.0"

Example HTTP response

Response 200

{
    "is_snapshot_policy": false,
    "snapshots": [],
    "volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}

1.24 - List Volume Groups

1.24.1 - 1.3

get /v1/volume-groups

Description

Get a list of Volume Groups.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
query	limit optional	Number to be displayed on the page Example : `20`	integer	20
query	offset optional	Offset Example : `0`	integer	0
query	sort optional	Sort Example : `column1:asc,column2:desc`	string	None
query	name optional	Volume group name Example : `vg-01`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-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 = baremetal-blockstorage 1.3"

Example HTTP response

Response 200

{
    "total_count": 1,
    "volume_groups": [
        {
            "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
            "created_at": "2024-08-01T07:06:23.315Z",
            "created_by": "samsung-cloud-platform1@samsung.com",
            "id": "c9ecae8b973b425c81c3817893cd8063",
            "modified_at": "2024-08-01T07:06:25.315Z",
            "modified_by": "samsung-cloud-platform2@samsung.com",
            "name": "vg-01",
            "num_of_block_storages": 2,
            "purpose": "ORG",
            "state": "CREATING"
        }
    ]
}

1.24.2 - 1.2

get /v1/volume-groups

Description

Get a list of Volume 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.2	20260531

Parameters

Type	Name	Description	Schema	Default
query	limit optional	Number to be displayed on the page Example : `20`	integer	20
query	offset optional	Offset Example : `0`	integer	0
query	sort optional	Sort Example : `column1:asc,column2:desc`	string	None
query	name optional	Volume group name Example : `vg-01`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-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 = baremetal-blockstorage 1.2"

Example HTTP response

Response 200

{
    "total_count": 1,
    "volume_groups": [
        {
            "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
            "created_at": "2024-08-01T07:06:23.315Z",
            "created_by": "samsung-cloud-platform1@samsung.com",
            "id": "c9ecae8b973b425c81c3817893cd8063",
            "modified_at": "2024-08-01T07:06:25.315Z",
            "modified_by": "samsung-cloud-platform2@samsung.com",
            "name": "vg-01",
            "num_of_block_storages": 2,
            "purpose": "ORG",
            "state": "CREATING"
        }
    ]
}

1.24.3 - 1.1

get /v1/volume-groups

Description

Get a list of Volume 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	20260331

Parameters

Type	Name	Description	Schema	Default
query	limit optional	Number to be displayed on the page Example : `20`	integer	20
query	offset optional	Offset Example : `0`	integer	0
query	sort optional	Sort Example : `column1:asc,column2:desc`	string	None
query	name optional	Volume group name Example : `vg-01`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-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 = baremetal-blockstorage 1.1"

Example HTTP response

Response 200

{
    "total_count": 1,
    "volume_groups": [
        {
            "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
            "created_at": "2024-08-01T07:06:23.315Z",
            "created_by": "samsung-cloud-platform1@samsung.com",
            "id": "c9ecae8b973b425c81c3817893cd8063",
            "modified_at": "2024-08-01T07:06:25.315Z",
            "modified_by": "samsung-cloud-platform2@samsung.com",
            "name": "vg-01",
            "num_of_block_storages": 2,
            "purpose": "ORG",
            "state": "CREATING"
        }
    ]
}

1.24.4 - 1.0

get /v1/volume-groups

Description

Get a list of Volume 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	limit optional	Number to be displayed on the page Example : `20`	integer	20
query	offset optional	Offset Example : `0`	integer	0
query	sort optional	Sort Example : `column1:asc,column2:desc`	string	None
query	name optional	Volume group name Example : `vg-01`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-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 = baremetal-blockstorage 1.0"

Example HTTP response

Response 200

{
    "total_count": 1,
    "volume_groups": [
        {
            "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
            "created_at": "2024-08-01T07:06:23.315Z",
            "created_by": "samsung-cloud-platform1@samsung.com",
            "id": "c9ecae8b973b425c81c3817893cd8063",
            "modified_at": "2024-08-01T07:06:25.315Z",
            "modified_by": "samsung-cloud-platform2@samsung.com",
            "name": "vg-01",
            "num_of_block_storages": 2,
            "purpose": "ORG",
            "state": "CREATING"
        }
    ]
}

1.25 - List Volume Snapshots

1.25.1 - 1.3

get /v1/volumes/{volume_id}/snapshots

Description

Get a list of Volume snapshots.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/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 = baremetal-blockstorage 1.3"

Example HTTP response

Response 200

{
    "is_snapshot_policy": false,
    "snapshot_capacity_mb": 0,
    "snapshot_capacity_rate": 0,
    "snapshot_total_usage": 0,
    "snapshots": [],
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

1.25.2 - 1.2

get /v1/volumes/{volume_id}/snapshots

Description

Get a list of Volume 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.2	20260531

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/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 = baremetal-blockstorage 1.2"

Example HTTP response

Response 200

{
    "is_snapshot_policy": false,
    "snapshot_capacity_mb": 0,
    "snapshot_capacity_rate": 0,
    "snapshot_total_usage": 0,
    "snapshots": [],
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

1.25.3 - 1.1

get /v1/volumes/{volume_id}/snapshots

Description

Get a list of Volume 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	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/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 = baremetal-blockstorage 1.1"

Example HTTP response

Response 200

{
    "is_snapshot_policy": false,
    "snapshot_capacity_mb": 0,
    "snapshot_capacity_rate": 0,
    "snapshot_total_usage": 0,
    "snapshots": [],
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

1.25.4 - 1.0

get /v1/volumes/{volume_id}/snapshots

Description

Get a list of Volume 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
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/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 = baremetal-blockstorage 1.0"

Example HTTP response

Response 200

{
    "is_snapshot_policy": false,
    "snapshot_capacity_mb": 0,
    "snapshot_capacity_rate": 0,
    "snapshot_total_usage": 0,
    "snapshots": [],
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

1.26 - List Volumes

1.26.1 - 1.3

get /v1/volumes

Description

Get a list of Volumes.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
query	limit optional	Number to be displayed on the page Example : `20`	integer	20
query	offset optional	Offset Example : `0`	integer	0
query	sort optional	Sort Example : `column1:asc,column2:desc`	string	None
query	name optional	Volume name Example : `bs-01`	string	None
query	object_name optional	Attached server name Example : `baremetal-server-name`	string	None
query	volume_group_name optional	Volume group name Example : `vg-01`	string	None

Responses

HTTP Code	Description	Schema
200	OK	VolumeListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	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 = baremetal-blockstorage 1.3"

Example HTTP response

Response 200

{
    "total_count": 1,
    "volumes": [
        {
            "attachments": [
                {
                    "id": "d7682135392e42489948c189e29011cc",
                    "name": "baremetal-01"
                }
            ],
            "created_at": "2026-04-14T15:04:43.509Z",
            "created_by": "samsung-cloud-platform1@samsung.com",
            "disk_type": "SSD",
            "has_relation": false,
            "id": "7239779c01e3405f82bb71c7f4b55fcd",
            "is_in_volume_group": false,
            "is_snapshot_activated": true,
            "iscsi_target_ips": {
                "description": "List of iscsi ips",
                "example": [
                    "172.30.4.3",
                    "172.30.4.4"
                ]
            },
            "modified_at": "2026-04-14T15:04:43.509Z",
            "modified_by": "samsung-cloud-platform2@samsung.com",
            "name": "bs-01",
            "purpose": "ORG",
            "size_gb": 10,
            "state": "CREATING",
            "volume_group": ""
        }
    ]
}

1.26.2 - 1.2

get /v1/volumes

Description

Get a list of 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.2	20260531

Parameters

Type	Name	Description	Schema	Default
query	limit optional	Number to be displayed on the page Example : `20`	integer	20
query	offset optional	Offset Example : `0`	integer	0
query	sort optional	Sort Example : `column1:asc,column2:desc`	string	None
query	name optional	Volume name Example : `bs-01`	string	None
query	object_name optional	Attached server name Example : `baremetal-server-name`	string	None
query	volume_group_name optional	Volume group name Example : `vg-01`	string	None

Responses

HTTP Code	Description	Schema
200	OK	VolumeListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	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 = baremetal-blockstorage 1.2"

Example HTTP response

Response 200

{
    "total_count": 1,
    "volumes": [
        {
            "attachments": [
                {
                    "id": "d7682135392e42489948c189e29011cc",
                    "name": "baremetal-01"
                }
            ],
            "created_at": "2026-04-14T15:04:42.795Z",
            "created_by": "samsung-cloud-platform1@samsung.com",
            "disk_type": "SSD",
            "has_relation": false,
            "id": "7239779c01e3405f82bb71c7f4b55fcd",
            "is_in_volume_group": false,
            "is_snapshot_activated": true,
            "iscsi_target_ips": {
                "description": "List of iscsi ips",
                "example": [
                    "172.30.4.3",
                    "172.30.4.4"
                ]
            },
            "modified_at": "2026-04-14T15:04:42.795Z",
            "modified_by": "samsung-cloud-platform2@samsung.com",
            "name": "bs-01",
            "purpose": "ORG",
            "size_gb": 10,
            "state": "CREATING",
            "volume_group": ""
        }
    ]
}

1.26.3 - 1.1

get /v1/volumes

Description

Get a list of 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	20260331

Parameters

Type	Name	Description	Schema	Default
query	limit optional	Number to be displayed on the page Example : `20`	integer	20
query	offset optional	Offset Example : `0`	integer	0
query	sort optional	Sort Example : `column1:asc,column2:desc`	string	None
query	name optional	Volume name Example : `bs-01`	string	None
query	object_name optional	Attached server name Example : `baremetal-server-name`	string	None
query	volume_group_name optional	Volume group name Example : `vg-01`	string	None

Responses

HTTP Code	Description	Schema
200	OK	VolumeListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	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 = baremetal-blockstorage 1.1"

Example HTTP response

Response 200

{
    "total_count": 1,
    "volumes": [
        {
            "attachments": [
                {
                    "id": "d7682135392e42489948c189e29011cc",
                    "name": "baremetal-01"
                }
            ],
            "created_at": "2026-04-14T15:04:42.098Z",
            "created_by": "samsung-cloud-platform1@samsung.com",
            "disk_type": "SSD",
            "has_relation": false,
            "id": "7239779c01e3405f82bb71c7f4b55fcd",
            "is_in_volume_group": false,
            "is_snapshot_activated": true,
            "iscsi_target_ips": {
                "description": "List of iscsi ips",
                "example": [
                    "172.30.4.3",
                    "172.30.4.4"
                ]
            },
            "modified_at": "2026-04-14T15:04:42.098Z",
            "modified_by": "samsung-cloud-platform2@samsung.com",
            "name": "bs-01",
            "purpose": "ORG",
            "size_gb": 10,
            "state": "CREATING",
            "volume_group": ""
        }
    ]
}

1.26.4 - 1.0

get /v1/volumes

Description

Get a list of 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	limit optional	Number to be displayed on the page Example : `20`	integer	20
query	offset optional	Offset Example : `0`	integer	0
query	sort optional	Sort Example : `column1:asc,column2:desc`	string	None
query	name optional	Volume name Example : `bs-01`	string	None
query	object_name optional	Attached server name Example : `baremetal-server-name`	string	None
query	volume_group_name optional	Volume group name Example : `vg-01`	string	None

Responses

HTTP Code	Description	Schema
200	OK	VolumeListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	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 = baremetal-blockstorage 1.0"

Example HTTP response

Response 200

{
    "total_count": 1,
    "volumes": [
        {
            "attachments": [
                {
                    "id": "d7682135392e42489948c189e29011cc",
                    "name": "baremetal-01"
                }
            ],
            "created_at": "2026-04-14T15:04:41.418Z",
            "created_by": "samsung-cloud-platform1@samsung.com",
            "disk_type": "SSD",
            "has_relation": false,
            "id": "7239779c01e3405f82bb71c7f4b55fcd",
            "is_in_volume_group": false,
            "is_snapshot_activated": true,
            "iscsi_target_ips": {
                "description": "List of iscsi ips",
                "example": [
                    "172.30.4.3",
                    "172.30.4.4"
                ]
            },
            "modified_at": "2026-04-14T15:04:41.418Z",
            "modified_by": "samsung-cloud-platform2@samsung.com",
            "name": "bs-01",
            "purpose": "ORG",
            "size_gb": 10,
            "state": "CREATING",
            "volume_group": ""
        }
    ]
}

1.27 - Remove Volume Group Member on Volume Group

1.27.1 - 1.3

put /v1/volume-groups/{volume_group_id}/members/remove

Description

Remove Volume Group Member on Volume Group.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
body	body required		VolumeGroupMemberRequest

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/members/remove

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-blockstorage 1.3"

Request body

{
    "volume_ids": [
        "13666d6c32d4456e8421f7768d0bf225"
    ]
}

Example HTTP response

Response 200

{
    "id": "c9ecae8b973b425c81c3817893cd8063",
    "member_volumes": [
        {
            "disk_type": "SSD",
            "id": "92cd16fe8ebc4f73832513a172bf0000",
            "name": "volume-01",
            "purpose": "ORG",
            "size_gb": 10,
            "so_volume_id": "",
            "so_volume_name": ""
        }
    ]
}

1.27.2 - 1.2

put /v1/volume-groups/{volume_group_id}/members/remove

Description

Remove Volume Group Member on Volume 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.2	20260531

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
body	body required		VolumeGroupMemberRequest

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/members/remove

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

Request body

{
    "volume_ids": [
        "13666d6c32d4456e8421f7768d0bf225"
    ]
}

Example HTTP response

Response 200

{
    "id": "c9ecae8b973b425c81c3817893cd8063",
    "member_volumes": [
        {
            "disk_type": "SSD",
            "id": "92cd16fe8ebc4f73832513a172bf0000",
            "name": "volume-01",
            "purpose": "ORG",
            "size_gb": 10,
            "so_volume_id": "",
            "so_volume_name": ""
        }
    ]
}

1.27.3 - 1.1

put /v1/volume-groups/{volume_group_id}/members/remove

Description

Remove Volume Group Member on Volume 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	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
body	body required		VolumeGroupMemberRequest

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/members/remove

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-blockstorage 1.1"

Request body

{
    "volume_ids": [
        "13666d6c32d4456e8421f7768d0bf225"
    ]
}

Example HTTP response

Response 200

{
    "id": "c9ecae8b973b425c81c3817893cd8063",
    "member_volumes": [
        {
            "disk_type": "SSD",
            "id": "92cd16fe8ebc4f73832513a172bf0000",
            "name": "volume-01",
            "purpose": "ORG",
            "size_gb": 10,
            "so_volume_id": "",
            "so_volume_name": ""
        }
    ]
}

1.27.4 - 1.0

put /v1/volume-groups/{volume_group_id}/members/remove

Description

Remove Volume Group Member on Volume 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	volume_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
body	body required		VolumeGroupMemberRequest

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/members/remove

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-blockstorage 1.0"

Request body

{
    "volume_ids": [
        "13666d6c32d4456e8421f7768d0bf225"
    ]
}

Example HTTP response

Response 200

{
    "id": "c9ecae8b973b425c81c3817893cd8063",
    "member_volumes": [
        {
            "disk_type": "SSD",
            "id": "92cd16fe8ebc4f73832513a172bf0000",
            "name": "volume-01",
            "purpose": "ORG",
            "size_gb": 10,
            "so_volume_id": "",
            "so_volume_name": ""
        }
    ]
}

1.28 - Restore Volume Group Snapshot

1.28.1 - 1.3

put /v1/volume-groups/{volume_group_id}/snapshots/{snapshot_id}/restore

Description

Restore Volume Group snapshot.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
path	snapshot_id required	Snapshot id Example : `05600123-6e78-11f0-a3f0-d039eab8d501`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/snapshots/{snapshot_id}/restore

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-blockstorage 1.3"

Example HTTP response

Response 200

{
    "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
    "snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501",
    "volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}

1.28.2 - 1.2

put /v1/volume-groups/{volume_group_id}/snapshots/{snapshot_id}/restore

Description

Restore Volume Group 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.2	20260531

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
path	snapshot_id required	Snapshot id Example : `05600123-6e78-11f0-a3f0-d039eab8d501`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/snapshots/{snapshot_id}/restore

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

Example HTTP response

Response 200

{
    "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
    "snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501",
    "volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}

1.28.3 - 1.1

put /v1/volume-groups/{volume_group_id}/snapshots/{snapshot_id}/restore

Description

Restore Volume Group 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	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
path	snapshot_id required	Snapshot id Example : `05600123-6e78-11f0-a3f0-d039eab8d501`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/snapshots/{snapshot_id}/restore

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-blockstorage 1.1"

Example HTTP response

Response 200

{
    "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
    "snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501",
    "volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}

1.28.4 - 1.0

put /v1/volume-groups/{volume_group_id}/snapshots/{snapshot_id}/restore

Description

Restore Volume Group 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	volume_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
path	snapshot_id required	Snapshot id Example : `05600123-6e78-11f0-a3f0-d039eab8d501`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/snapshots/{snapshot_id}/restore

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-blockstorage 1.0"

Example HTTP response

Response 200

{
    "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
    "snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501",
    "volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}

1.29 - Restore Volume Snapshot

1.29.1 - 1.3

put /v1/volumes/{volume_id}/snapshots/{snapshot_id}/restore

Description

Restore Volume from snapshot.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
path	snapshot_id required	Snapshot id Example : `05600123-6e78-11f0-a3f0-d039eab8d501`	string	None

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/snapshots/{snapshot_id}/restore

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-blockstorage 1.3"

Example HTTP response

Response 200

{
    "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
    "snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501",
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

1.29.2 - 1.2

put /v1/volumes/{volume_id}/snapshots/{snapshot_id}/restore

Description

Restore Volume from 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.2	20260531

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
path	snapshot_id required	Snapshot id Example : `05600123-6e78-11f0-a3f0-d039eab8d501`	string	None

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/snapshots/{snapshot_id}/restore

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

Example HTTP response

Response 200

{
    "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
    "snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501",
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

1.29.3 - 1.1

put /v1/volumes/{volume_id}/snapshots/{snapshot_id}/restore

Description

Restore Volume from 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	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
path	snapshot_id required	Snapshot id Example : `05600123-6e78-11f0-a3f0-d039eab8d501`	string	None

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/snapshots/{snapshot_id}/restore

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-blockstorage 1.1"

Example HTTP response

Response 200

{
    "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
    "snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501",
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

1.29.4 - 1.0

put /v1/volumes/{volume_id}/snapshots/{snapshot_id}/restore

Description

Restore Volume from 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	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
path	snapshot_id required	Snapshot id Example : `05600123-6e78-11f0-a3f0-d039eab8d501`	string	None

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/snapshots/{snapshot_id}/restore

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-blockstorage 1.0"

Example HTTP response

Response 200

{
    "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
    "snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501",
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

1.30 - Set Volume Group Replication Cycle

1.30.1 - 1.3

put /v1/volume-groups/{volume_group_id}/replications/cycle

Description

Set Volume Group Replication Cycle.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
body	body required		VolumeGroupReplicationUpdateCycleRequest

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/replications/cycle

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-blockstorage 1.3"

Request body

{
    "cycle": "5MIN"
}

Example HTTP response

Response 200

{
    "cycle": "5MIN",
    "volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}

1.30.2 - 1.2

put /v1/volume-groups/{volume_group_id}/replications/cycle

Description

Set Volume Group Replication Cycle.

State ACTIVE (DEPRECATED)

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

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
body	body required		VolumeGroupReplicationUpdateCycleRequest

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/replications/cycle

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

Request body

{
    "cycle": "5MIN"
}

Example HTTP response

Response 200

{
    "cycle": "5MIN",
    "volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}

1.30.3 - 1.1

put /v1/volume-groups/{volume_group_id}/replications/cycle

Description

Set Volume Group Replication Cycle.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
body	body required		VolumeGroupReplicationUpdateCycleRequest

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/replications/cycle

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-blockstorage 1.1"

Request body

{
    "cycle": "5MIN"
}

Example HTTP response

Response 200

{
    "cycle": "5MIN",
    "volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}

1.30.4 - 1.0

put /v1/volume-groups/{volume_group_id}/replications/cycle

Description

Set Volume Group Replication Cycle.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or 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_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
body	body required		VolumeGroupReplicationUpdateCycleRequest

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/replications/cycle

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-blockstorage 1.0"

Request body

{
    "cycle": "5MIN"
}

Example HTTP response

Response 200

{
    "cycle": "5MIN",
    "volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}

1.31 - Set Volume Group Replication Policy

1.31.1 - 1.3

put /v1/volume-groups/{volume_group_id}/replications/policy

Description

Set Volume Group Replication Policy.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
body	body required		VolumeGroupReplicationUpdatePolicyRequest

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/replications/policy

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-blockstorage 1.3"

Request body

{
    "policy": "RESYNC"
}

Example HTTP response

Response 200

{
    "cycle": "5MIN",
    "sync_state": "SNAPMIRROED"
}

1.31.2 - 1.2

put /v1/volume-groups/{volume_group_id}/replications/policy

Description

Set Volume Group Replication 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.2	20260531

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
body	body required		VolumeGroupReplicationUpdatePolicyRequest

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/replications/policy

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

Request body

{
    "policy": "RESYNC"
}

Example HTTP response

Response 200

{
    "cycle": "5MIN",
    "sync_state": "SNAPMIRROED"
}

1.31.3 - 1.1

put /v1/volume-groups/{volume_group_id}/replications/policy

Description

Set Volume Group Replication 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	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
body	body required		VolumeGroupReplicationUpdatePolicyRequest

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/replications/policy

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-blockstorage 1.1"

Request body

{
    "policy": "RESYNC"
}

Example HTTP response

Response 200

{
    "cycle": "5MIN",
    "sync_state": "SNAPMIRROED"
}

1.31.4 - 1.0

put /v1/volume-groups/{volume_group_id}/replications/policy

Description

Set Volume Group Replication 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	volume_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
body	body required		VolumeGroupReplicationUpdatePolicyRequest

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/replications/policy

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-blockstorage 1.0"

Request body

{
    "policy": "RESYNC"
}

Example HTTP response

Response 200

{
    "cycle": "5MIN",
    "sync_state": "SNAPMIRROED"
}

1.32 - Set Volume Group Snapshot Schedule

1.32.1 - 1.3

put /v1/volume-groups/{volume_group_id}/snapshot-schedules

Description

Set Volume Group Snapshot Schedule.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
body	body required		VolumeGroupSnapshotScheduleRequest

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/snapshot-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 = baremetal-blockstorage 1.3"

Request body

{
    "day_of_week": "SUN",
    "hour": 18
}

Example HTTP response

Response 200

{
    "day_of_week": "SUN",
    "frequency": "DAILY",
    "hour": 18,
    "volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}

1.32.2 - 1.2

put /v1/volume-groups/{volume_group_id}/snapshot-schedules

Description

Set Volume Group Snapshot 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.2	20260531

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
body	body required		VolumeGroupSnapshotScheduleRequest

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/snapshot-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 = baremetal-blockstorage 1.2"

Request body

{
    "day_of_week": "SUN",
    "hour": 18
}

Example HTTP response

Response 200

{
    "day_of_week": "SUN",
    "frequency": "DAILY",
    "hour": 18,
    "volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}

1.32.3 - 1.1

put /v1/volume-groups/{volume_group_id}/snapshot-schedules

Description

Set Volume Group Snapshot 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	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
body	body required		VolumeGroupSnapshotScheduleRequest

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/snapshot-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 = baremetal-blockstorage 1.1"

Request body

{
    "day_of_week": "SUN",
    "hour": 18
}

Example HTTP response

Response 200

{
    "day_of_week": "SUN",
    "frequency": "DAILY",
    "hour": 18,
    "volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}

1.32.4 - 1.0

put /v1/volume-groups/{volume_group_id}/snapshot-schedules

Description

Set Volume Group Snapshot 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	volume_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
body	body required		VolumeGroupSnapshotScheduleRequest

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/snapshot-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 = baremetal-blockstorage 1.0"

Request body

{
    "day_of_week": "SUN",
    "hour": 18
}

Example HTTP response

Response 200

{
    "day_of_week": "SUN",
    "frequency": "DAILY",
    "hour": 18,
    "volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}

1.33 - Set Volume QoS

1.33.1 - 1.3

put /v1/volumes/{volume_id}/qos

Description

Change volume QoS

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		SetVolumeQoSRequest

Responses

HTTP Code	Description	Schema
200	OK	SetVolumeQoSResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	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 = baremetal-blockstorage 1.3"

Request body

{
    "iops": 5000,
    "throughput": 250
}

Example HTTP response

Response 200

{
    "iops": 5000,
    "throughput": 250
}

1.33.2 - 1.2

put /v1/volumes/{volume_id}/qos

Description

Change volume QoS

State ACTIVE (DEPRECATED)

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

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		SetVolumeQoSRequest

Responses

HTTP Code	Description	Schema
200	OK	SetVolumeQoSResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	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 = baremetal-blockstorage 1.2"

Request body

{
    "iops": 5000,
    "throughput": 250
}

Example HTTP response

Response 200

{
    "iops": 5000,
    "throughput": 250
}

1.34 - Set Volume Replication Cycle

1.34.1 - 1.3

put /v1/volumes/{volume_id}/replications/cycle

Description

Set Volume Replication Cycle.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeReplicationCycleRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/replications/cycle

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-blockstorage 1.3"

Request body

{
    "cycle": "5MIN"
}

Example HTTP response

Response 200

{
    "cycle": "5MIN",
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

1.34.2 - 1.2

put /v1/volumes/{volume_id}/replications/cycle

Description

Set Volume Replication Cycle.

State ACTIVE (DEPRECATED)

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

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeReplicationCycleRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/replications/cycle

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

Request body

{
    "cycle": "5MIN"
}

Example HTTP response

Response 200

{
    "cycle": "5MIN",
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

1.34.3 - 1.1

put /v1/volumes/{volume_id}/replications/cycle

Description

Set Volume Replication Cycle.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeReplicationCycleRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/replications/cycle

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-blockstorage 1.1"

Request body

{
    "cycle": "5MIN"
}

Example HTTP response

Response 200

{
    "cycle": "5MIN",
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

1.34.4 - 1.0

put /v1/volumes/{volume_id}/replications/cycle

Description

Set Volume Replication Cycle.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or 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 : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeReplicationCycleRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/replications/cycle

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-blockstorage 1.0"

Request body

{
    "cycle": "5MIN"
}

Example HTTP response

Response 200

{
    "cycle": "5MIN",
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

1.35 - Set Volume Replication Policy

1.35.1 - 1.3

put /v1/volumes/{volume_id}/replications/policy

Description

Set Volume Replication Policy.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeReplicationPolicyRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/replications/policy

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-blockstorage 1.3"

Request body

{
    "policy": "RESYNC"
}

Example HTTP response

Response 200

{
    "sync_cycle": "5MIN",
    "sync_state": "SNAPMIRROED"
}

1.35.2 - 1.2

put /v1/volumes/{volume_id}/replications/policy

Description

Set Volume Replication 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.2	20260531

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeReplicationPolicyRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/replications/policy

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

Request body

{
    "policy": "RESYNC"
}

Example HTTP response

Response 200

{
    "sync_cycle": "5MIN",
    "sync_state": "SNAPMIRROED"
}

1.35.3 - 1.1

put /v1/volumes/{volume_id}/replications/policy

Description

Set Volume Replication 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	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeReplicationPolicyRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/replications/policy

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-blockstorage 1.1"

Request body

{
    "policy": "RESYNC"
}

Example HTTP response

Response 200

{
    "sync_cycle": "5MIN",
    "sync_state": "SNAPMIRROED"
}

1.35.4 - 1.0

put /v1/volumes/{volume_id}/replications/policy

Description

Set Volume Replication 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	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeReplicationPolicyRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/replications/policy

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-blockstorage 1.0"

Request body

{
    "policy": "RESYNC"
}

Example HTTP response

Response 200

{
    "sync_cycle": "5MIN",
    "sync_state": "SNAPMIRROED"
}

1.36 - Set Volume Snapshot Rate

1.36.1 - 1.3

put /v1/volumes/{volume_id}/snapshot-rates

Description

Set Volume snapshot rate.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeSnapshotRateRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/snapshot-rates

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-blockstorage 1.3"

Request body

{
    "snapshot_rate": 100
}

Example HTTP response

Response 200

{
    "is_snapshot_activated": true,
    "snapshot_rate": 100,
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

1.36.2 - 1.2

put /v1/volumes/{volume_id}/snapshot-rates

Description

Set Volume snapshot rate.

State ACTIVE (DEPRECATED)

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

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeSnapshotRateRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/snapshot-rates

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

Request body

{
    "snapshot_rate": 100
}

Example HTTP response

Response 200

{
    "is_snapshot_activated": true,
    "snapshot_rate": 100,
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

1.36.3 - 1.1

put /v1/volumes/{volume_id}/snapshot-rates

Description

Set Volume snapshot rate.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeSnapshotRateRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/snapshot-rates

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-blockstorage 1.1"

Request body

{
    "snapshot_rate": 100
}

Example HTTP response

Response 200

{
    "is_snapshot_activated": true,
    "snapshot_rate": 100,
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

1.36.4 - 1.0

put /v1/volumes/{volume_id}/snapshot-rates

Description

Set Volume snapshot rate.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or 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 : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeSnapshotRateRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/snapshot-rates

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-blockstorage 1.0"

Request body

{
    "snapshot_rate": 100
}

Example HTTP response

Response 200

{
    "is_snapshot_activated": true,
    "snapshot_rate": 100,
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

1.37 - Set Volume Snapshot Schedule

1.37.1 - 1.3

put /v1/volumes/{volume_id}/snapshot-schedules

Description

Set Volume snapshot schedule.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeSnapshotScheduleRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/snapshot-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 = baremetal-blockstorage 1.3"

Request body

{
    "day_of_week": "SUN",
    "hour": 18
}

Example HTTP response

Response 200

{
    "day_of_week": "",
    "frequency": "DAILY",
    "hour": 18,
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

1.37.2 - 1.2

put /v1/volumes/{volume_id}/snapshot-schedules

Description

Set Volume snapshot 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.2	20260531

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeSnapshotScheduleRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/snapshot-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 = baremetal-blockstorage 1.2"

Request body

{
    "day_of_week": "SUN",
    "hour": 18
}

Example HTTP response

Response 200

{
    "day_of_week": "",
    "frequency": "DAILY",
    "hour": 18,
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

1.37.3 - 1.1

put /v1/volumes/{volume_id}/snapshot-schedules

Description

Set Volume snapshot 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	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeSnapshotScheduleRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/snapshot-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 = baremetal-blockstorage 1.1"

Request body

{
    "day_of_week": "SUN",
    "hour": 18
}

Example HTTP response

Response 200

{
    "day_of_week": "",
    "frequency": "DAILY",
    "hour": 18,
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

1.37.4 - 1.0

put /v1/volumes/{volume_id}/snapshot-schedules

Description

Set Volume snapshot 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	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeSnapshotScheduleRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/snapshot-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 = baremetal-blockstorage 1.0"

Request body

{
    "day_of_week": "SUN",
    "hour": 18
}

Example HTTP response

Response 200

{
    "day_of_week": "",
    "frequency": "DAILY",
    "hour": 18,
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

1.38 - Show Volume

1.38.1 - 1.3

get /v1/volumes/{volume_id}

Description

Show Volume.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None

Responses

HTTP Code	Description	Schema
200	OK	VolumeResponseV1Dot2
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	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 = baremetal-blockstorage 1.3"

Example HTTP response

Response 200

{
    "result": {
        "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
        "attachments": [
            {
                "id": "83c3c73d457345e3829ee6d5557c0011",
                "image_name": "RHEL 8.8 for BM",
                "name": "baremetal-01",
                "srn": "srn:dev2::36827d9b643f46c2ae6bb7e63d633bfe:kr-west1::baremetal-blockstorage:volume/97cd36e3c1984c8cad3ec193aeda25e0",
                "state": "RUNNING",
                "type": "BM"
            }
        ],
        "created_at": "2024-08-01T07:06:23.315Z",
        "created_by": "samsung-cloud-platform1@samsung.com",
        "disk_type": "SSD",
        "external_errors": [
            {
                "code": "Forbidden",
                "object_type": "BM",
                "status": 403
            }
        ],
        "has_origin": true,
        "has_replication": true,
        "id": "7239779c01e3405f82bb71c7f4b55fcd",
        "is_encryption": true,
        "iscsi_target_ips": [
            "172.30.4.3",
            "172.30.4.4"
        ],
        "modified_at": "2024-08-01T07:06:25.315Z",
        "modified_by": "samsung-cloud-platform2@samsung.com",
        "name": "bs-01",
        "previous_state": "CREATING",
        "purpose": "ORG",
        "qos": {
            "iops": 5000,
            "throughput": 250
        },
        "recovery": {
            "origin_volume": {
                "attachments": [
                    {
                        "id": "83c3c73d457345e3829ee6d5557c0011",
                        "type": "BM"
                    }
                ],
                "id": "7239779c01e3405f82bb71c7f4b55fcd",
                "name": "bs-01"
            },
            "recovery_volume": {
                "attachments": [
                    {
                        "id": "83c3c73d457345e3829ee6d5557c0011",
                        "type": "BM"
                    }
                ],
                "id": "7239779c01e3405f82bb71c7f4b55fcd",
                "name": "bs-01"
            }
        },
        "size_gb": 10,
        "snapshot_rate": 100,
        "snapshot_schedule": {
            "day_of_week": "MON",
            "frequency": "DAILY",
            "hour": 18
        },
        "srn": "srn:dev2::36827d9b643f46c2ae6bb7e63d633bfe:kr-west1::baremetal-blockstorage:volume/97cd36e3c1984c8cad3ec193aeda25e0",
        "state": "CREATING",
        "storage_volume_name": "vo202407310544da8aadc775f",
        "volume_group": {
            "id": "7239779c01e3405f82bb71c7f4b55fcd",
            "name": "vg-01"
        }
    }
}

1.38.2 - 1.2

get /v1/volumes/{volume_id}

Description

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

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None

Responses

HTTP Code	Description	Schema
200	OK	VolumeResponseV1Dot2
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	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 = baremetal-blockstorage 1.2"

Example HTTP response

Response 200

{
    "result": {
        "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
        "attachments": [
            {
                "id": "83c3c73d457345e3829ee6d5557c0011",
                "image_name": "RHEL 8.8 for BM",
                "name": "baremetal-01",
                "srn": "srn:dev2::36827d9b643f46c2ae6bb7e63d633bfe:kr-west1::baremetal-blockstorage:volume/97cd36e3c1984c8cad3ec193aeda25e0",
                "state": "RUNNING",
                "type": "BM"
            }
        ],
        "created_at": "2024-08-01T07:06:23.315Z",
        "created_by": "samsung-cloud-platform1@samsung.com",
        "disk_type": "SSD",
        "external_errors": [
            {
                "code": "Forbidden",
                "object_type": "BM",
                "status": 403
            }
        ],
        "has_origin": true,
        "has_replication": true,
        "id": "7239779c01e3405f82bb71c7f4b55fcd",
        "is_encryption": true,
        "iscsi_target_ips": [
            "172.30.4.3",
            "172.30.4.4"
        ],
        "modified_at": "2024-08-01T07:06:25.315Z",
        "modified_by": "samsung-cloud-platform2@samsung.com",
        "name": "bs-01",
        "previous_state": "CREATING",
        "purpose": "ORG",
        "qos": {
            "iops": 5000,
            "throughput": 250
        },
        "recovery": {
            "origin_volume": {
                "attachments": [
                    {
                        "id": "83c3c73d457345e3829ee6d5557c0011",
                        "type": "BM"
                    }
                ],
                "id": "7239779c01e3405f82bb71c7f4b55fcd",
                "name": "bs-01"
            },
            "recovery_volume": {
                "attachments": [
                    {
                        "id": "83c3c73d457345e3829ee6d5557c0011",
                        "type": "BM"
                    }
                ],
                "id": "7239779c01e3405f82bb71c7f4b55fcd",
                "name": "bs-01"
            }
        },
        "size_gb": 10,
        "snapshot_rate": 100,
        "snapshot_schedule": {
            "day_of_week": "MON",
            "frequency": "DAILY",
            "hour": 18
        },
        "srn": "srn:dev2::36827d9b643f46c2ae6bb7e63d633bfe:kr-west1::baremetal-blockstorage:volume/97cd36e3c1984c8cad3ec193aeda25e0",
        "state": "CREATING",
        "storage_volume_name": "vo202407310544da8aadc775f",
        "volume_group": {
            "id": "7239779c01e3405f82bb71c7f4b55fcd",
            "name": "vg-01"
        }
    }
}

1.38.3 - 1.1

get /v1/volumes/{volume_id}

Description

Show 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	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None

Responses

HTTP Code	Description	Schema
200	OK	VolumeResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	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 = baremetal-blockstorage 1.1"

Example HTTP response

Response 200

{
    "result": {
        "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
        "attachments": [
            {
                "id": "83c3c73d457345e3829ee6d5557c0011",
                "image_name": "RHEL 8.8 for BM",
                "name": "baremetal-01",
                "srn": "srn:dev2::36827d9b643f46c2ae6bb7e63d633bfe:kr-west1::baremetal-blockstorage:volume/97cd36e3c1984c8cad3ec193aeda25e0",
                "state": "RUNNING",
                "type": "BM"
            }
        ],
        "created_at": "2024-08-01T07:06:23.315Z",
        "created_by": "samsung-cloud-platform1@samsung.com",
        "disk_type": "SSD",
        "external_errors": [
            {
                "code": "Forbidden",
                "object_type": "BM",
                "status": 403
            }
        ],
        "has_origin": true,
        "has_replication": true,
        "id": "7239779c01e3405f82bb71c7f4b55fcd",
        "is_encryption": true,
        "iscsi_target_ips": [
            "172.30.4.3",
            "172.30.4.4"
        ],
        "modified_at": "2024-08-01T07:06:25.315Z",
        "modified_by": "samsung-cloud-platform2@samsung.com",
        "name": "bs-01",
        "previous_state": "CREATING",
        "purpose": "ORG",
        "recovery": {
            "origin_volume": {
                "attachments": [
                    {
                        "id": "83c3c73d457345e3829ee6d5557c0011",
                        "type": "BM"
                    }
                ],
                "id": "7239779c01e3405f82bb71c7f4b55fcd",
                "name": "bs-01"
            },
            "recovery_volume": {
                "attachments": [
                    {
                        "id": "83c3c73d457345e3829ee6d5557c0011",
                        "type": "BM"
                    }
                ],
                "id": "7239779c01e3405f82bb71c7f4b55fcd",
                "name": "bs-01"
            }
        },
        "size_gb": 10,
        "snapshot_rate": 100,
        "snapshot_schedule": {
            "day_of_week": "MON",
            "frequency": "DAILY",
            "hour": 18
        },
        "srn": "srn:dev2::36827d9b643f46c2ae6bb7e63d633bfe:kr-west1::baremetal-blockstorage:volume/97cd36e3c1984c8cad3ec193aeda25e0",
        "state": "CREATING",
        "storage_volume_name": "vo202407310544da8aadc775f",
        "volume_group": {
            "id": "7239779c01e3405f82bb71c7f4b55fcd",
            "name": "vg-01"
        }
    }
}

1.38.4 - 1.0

get /v1/volumes/{volume_id}

Description

Show 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 : `92cd16fe8ebc4f73832513a172bf0000`	string	None

Responses

HTTP Code	Description	Schema
200	OK	VolumeResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	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 = baremetal-blockstorage 1.0"

Example HTTP response

Response 200

{
    "result": {
        "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
        "attachments": [
            {
                "id": "83c3c73d457345e3829ee6d5557c0011",
                "image_name": "RHEL 8.8 for BM",
                "name": "baremetal-01",
                "srn": "srn:dev2::36827d9b643f46c2ae6bb7e63d633bfe:kr-west1::baremetal-blockstorage:volume/97cd36e3c1984c8cad3ec193aeda25e0",
                "state": "RUNNING",
                "type": "BM"
            }
        ],
        "created_at": "2024-08-01T07:06:23.315Z",
        "created_by": "samsung-cloud-platform1@samsung.com",
        "disk_type": "SSD",
        "external_errors": [
            {
                "code": "Forbidden",
                "object_type": "BM",
                "status": 403
            }
        ],
        "has_origin": true,
        "has_replication": true,
        "id": "7239779c01e3405f82bb71c7f4b55fcd",
        "is_encryption": true,
        "iscsi_target_ips": [
            "172.30.4.3",
            "172.30.4.4"
        ],
        "modified_at": "2024-08-01T07:06:25.315Z",
        "modified_by": "samsung-cloud-platform2@samsung.com",
        "name": "bs-01",
        "previous_state": "CREATING",
        "purpose": "ORG",
        "recovery": {
            "origin_volume": {
                "attachments": [
                    {
                        "id": "83c3c73d457345e3829ee6d5557c0011",
                        "type": "BM"
                    }
                ],
                "id": "7239779c01e3405f82bb71c7f4b55fcd",
                "name": "bs-01"
            },
            "recovery_volume": {
                "attachments": [
                    {
                        "id": "83c3c73d457345e3829ee6d5557c0011",
                        "type": "BM"
                    }
                ],
                "id": "7239779c01e3405f82bb71c7f4b55fcd",
                "name": "bs-01"
            }
        },
        "size_gb": 10,
        "snapshot_rate": 100,
        "snapshot_schedule": {
            "day_of_week": "MON",
            "frequency": "DAILY",
            "hour": 18
        },
        "srn": "srn:dev2::36827d9b643f46c2ae6bb7e63d633bfe:kr-west1::baremetal-blockstorage:volume/97cd36e3c1984c8cad3ec193aeda25e0",
        "state": "CREATING",
        "storage_volume_name": "vo202407310544da8aadc775f",
        "volume_group": {
            "id": "7239779c01e3405f82bb71c7f4b55fcd",
            "name": "vg-01"
        }
    }
}

1.39 - Show Volume Group

1.39.1 - 1.3

get /v1/volume-groups/{volume_group_id}

Description

Show Volume Group

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_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 = baremetal-blockstorage 1.3"

Example HTTP response

Response 200

{
    "result": {
        "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
        "created_at": "2024-08-01T07:06:23.315Z",
        "created_by": "samsung-cloud-platform1@samsung.com",
        "has_origin": true,
        "has_replication": true,
        "id": "c9ecae8b973b425c81c3817893cd8063",
        "member_volumes": [
            {
                "disk_type": "SSD",
                "id": "92cd16fe8ebc4f73832513a172bf0000",
                "name": "bs-01",
                "origin_volume": {
                    "id": "7239779c01e3405f82bb71c7f4b55fcd",
                    "name": "my_name"
                },
                "recovery_volume": {
                    "id": "7239779c01e3405f82bb71c7f4b55fcd",
                    "name": "my_name"
                },
                "size_gb": 10,
                "snapshot_rate": 100,
                "state": "CREATING"
            }
        ],
        "modified_at": "2024-08-01T07:06:25.315Z",
        "modified_by": "samsung-cloud-platform2@samsung.com",
        "name": "vg-01",
        "purpose": "ORG",
        "recovery": {
            "origin_volume_group": {
                "id": "7239779c01e3405f82bb71c7f4b55fcd",
                "name": "my_name"
            },
            "recovery_volume_group": {
                "id": "7239779c01e3405f82bb71c7f4b55fcd",
                "name": "my_name"
            }
        },
        "snapshot_schedule": {
            "day_of_week": "MON",
            "frequency": "DAILY",
            "hour": 18
        },
        "so_storage_id": 200,
        "so_volume_pool_id": "bm-01",
        "state": "CREATING",
        "storage_volume_group_name": "go02407310544da8aadc775f"
    }
}

1.39.2 - 1.2

get /v1/volume-groups/{volume_group_id}

Description

Show Volume 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.2	20260531

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_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 = baremetal-blockstorage 1.2"

Example HTTP response

Response 200

{
    "result": {
        "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
        "created_at": "2024-08-01T07:06:23.315Z",
        "created_by": "samsung-cloud-platform1@samsung.com",
        "has_origin": true,
        "has_replication": true,
        "id": "c9ecae8b973b425c81c3817893cd8063",
        "member_volumes": [
            {
                "disk_type": "SSD",
                "id": "92cd16fe8ebc4f73832513a172bf0000",
                "name": "bs-01",
                "origin_volume": {
                    "id": "7239779c01e3405f82bb71c7f4b55fcd",
                    "name": "my_name"
                },
                "recovery_volume": {
                    "id": "7239779c01e3405f82bb71c7f4b55fcd",
                    "name": "my_name"
                },
                "size_gb": 10,
                "snapshot_rate": 100,
                "state": "CREATING"
            }
        ],
        "modified_at": "2024-08-01T07:06:25.315Z",
        "modified_by": "samsung-cloud-platform2@samsung.com",
        "name": "vg-01",
        "purpose": "ORG",
        "recovery": {
            "origin_volume_group": {
                "id": "7239779c01e3405f82bb71c7f4b55fcd",
                "name": "my_name"
            },
            "recovery_volume_group": {
                "id": "7239779c01e3405f82bb71c7f4b55fcd",
                "name": "my_name"
            }
        },
        "snapshot_schedule": {
            "day_of_week": "MON",
            "frequency": "DAILY",
            "hour": 18
        },
        "so_storage_id": 200,
        "so_volume_pool_id": "bm-01",
        "state": "CREATING",
        "storage_volume_group_name": "go02407310544da8aadc775f"
    }
}

1.39.3 - 1.1

get /v1/volume-groups/{volume_group_id}

Description

Show Volume 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	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_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 = baremetal-blockstorage 1.1"

Example HTTP response

Response 200

{
    "result": {
        "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
        "created_at": "2024-08-01T07:06:23.315Z",
        "created_by": "samsung-cloud-platform1@samsung.com",
        "has_origin": true,
        "has_replication": true,
        "id": "c9ecae8b973b425c81c3817893cd8063",
        "member_volumes": [
            {
                "disk_type": "SSD",
                "id": "92cd16fe8ebc4f73832513a172bf0000",
                "name": "bs-01",
                "origin_volume": {
                    "id": "7239779c01e3405f82bb71c7f4b55fcd",
                    "name": "my_name"
                },
                "recovery_volume": {
                    "id": "7239779c01e3405f82bb71c7f4b55fcd",
                    "name": "my_name"
                },
                "size_gb": 10,
                "snapshot_rate": 100,
                "state": "CREATING"
            }
        ],
        "modified_at": "2024-08-01T07:06:25.315Z",
        "modified_by": "samsung-cloud-platform2@samsung.com",
        "name": "vg-01",
        "purpose": "ORG",
        "recovery": {
            "origin_volume_group": {
                "id": "7239779c01e3405f82bb71c7f4b55fcd",
                "name": "my_name"
            },
            "recovery_volume_group": {
                "id": "7239779c01e3405f82bb71c7f4b55fcd",
                "name": "my_name"
            }
        },
        "snapshot_schedule": {
            "day_of_week": "MON",
            "frequency": "DAILY",
            "hour": 18
        },
        "so_storage_id": 200,
        "so_volume_pool_id": "bm-01",
        "state": "CREATING",
        "storage_volume_group_name": "go02407310544da8aadc775f"
    }
}

1.39.4 - 1.0

get /v1/volume-groups/{volume_group_id}

Description

Show Volume 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	volume_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_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 = baremetal-blockstorage 1.0"

Example HTTP response

Response 200

{
    "result": {
        "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
        "created_at": "2024-08-01T07:06:23.315Z",
        "created_by": "samsung-cloud-platform1@samsung.com",
        "has_origin": true,
        "has_replication": true,
        "id": "c9ecae8b973b425c81c3817893cd8063",
        "member_volumes": [
            {
                "disk_type": "SSD",
                "id": "92cd16fe8ebc4f73832513a172bf0000",
                "name": "bs-01",
                "origin_volume": {
                    "id": "7239779c01e3405f82bb71c7f4b55fcd",
                    "name": "my_name"
                },
                "recovery_volume": {
                    "id": "7239779c01e3405f82bb71c7f4b55fcd",
                    "name": "my_name"
                },
                "size_gb": 10,
                "snapshot_rate": 100,
                "state": "CREATING"
            }
        ],
        "modified_at": "2024-08-01T07:06:25.315Z",
        "modified_by": "samsung-cloud-platform2@samsung.com",
        "name": "vg-01",
        "purpose": "ORG",
        "recovery": {
            "origin_volume_group": {
                "id": "7239779c01e3405f82bb71c7f4b55fcd",
                "name": "my_name"
            },
            "recovery_volume_group": {
                "id": "7239779c01e3405f82bb71c7f4b55fcd",
                "name": "my_name"
            }
        },
        "snapshot_schedule": {
            "day_of_week": "MON",
            "frequency": "DAILY",
            "hour": 18
        },
        "so_storage_id": 200,
        "so_volume_pool_id": "bm-01",
        "state": "CREATING",
        "storage_volume_group_name": "go02407310544da8aadc775f"
    }
}

1.40 - Show Volume Group Replication

1.40.1 - 1.3

get /v1/volume-groups/{volume_group_id}/replications

Description

Show Volume Group Replication

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/replications

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-blockstorage 1.3"

Example HTTP response

Response 200

{
    "result": {
        "lag_time": "01:23:45",
        "related_volume_groups": [],
        "sync_cycle": "5MIN",
        "sync_state": "SNAPMIRROED"
    }
}

1.40.2 - 1.2

get /v1/volume-groups/{volume_group_id}/replications

Description

Show Volume Group Replication

State ACTIVE (DEPRECATED)

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

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/replications

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

Example HTTP response

Response 200

{
    "result": {
        "related_volume_groups": [],
        "sync_cycle": "5MIN",
        "sync_state": "SNAPMIRROED"
    }
}

1.40.3 - 1.1

get /v1/volume-groups/{volume_group_id}/replications

Description

Show Volume Group Replication

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/replications

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-blockstorage 1.1"

Example HTTP response

Response 200

{
    "result": {
        "related_volume_groups": [],
        "sync_cycle": "5MIN",
        "sync_state": "SNAPMIRROED"
    }
}

1.40.4 - 1.0

get /v1/volume-groups/{volume_group_id}/replications

Description

Show Volume Group Replication

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or 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_group_id required	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/replications

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-blockstorage 1.0"

Example HTTP response

Response 200

{
    "result": {
        "related_volume_groups": [],
        "sync_cycle": "5MIN",
        "sync_state": "SNAPMIRROED"
    }
}

1.41 - Show Volume Replication

1.41.1 - 1.3

get /v1/volumes/{volume_id}/replications

Description

Show Volume Replication.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/replications

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-blockstorage 1.3"

Example HTTP response

Response 200

{
    "result": {
        "lag_time": "01:23:45",
        "related_volumes": [],
        "sync_cycle": "5MIN",
        "sync_state": "SNAPMIRROED"
    }
}

1.41.2 - 1.2

get /v1/volumes/{volume_id}/replications

Description

Show Volume Replication.

State ACTIVE (DEPRECATED)

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

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/replications

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

Example HTTP response

Response 200

{
    "result": {
        "related_volumes": [],
        "sync_cycle": "5MIN",
        "sync_state": "SNAPMIRROED"
    }
}

1.41.3 - 1.1

get /v1/volumes/{volume_id}/replications

Description

Show Volume Replication.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/replications

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-blockstorage 1.1"

Example HTTP response

Response 200

{
    "result": {
        "related_volumes": [],
        "sync_cycle": "5MIN",
        "sync_state": "SNAPMIRROED"
    }
}

1.41.4 - 1.0

get /v1/volumes/{volume_id}/replications

Description

Show Volume Replication.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or 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 : `92cd16fe8ebc4f73832513a172bf0000`	string	None

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/replications

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-blockstorage 1.0"

Example HTTP response

Response 200

{
    "result": {
        "related_volumes": [],
        "sync_cycle": "5MIN",
        "sync_state": "SNAPMIRROED"
    }
}

2 - Models

2.1 - AsyncResponse

Name	Description	Schema	Default
request_id optional	Request id Example : `req-0006064c-c008-458c-8977-19671c6b32d4`	string
resource_id optional	Resource id Example : `8bf55e738d4e44b5a21dbe133a42ecbe`	string

2.2 - AttachedServer

Name	Description	Schema
id optional	Server id Example : `83c3c73d457345e3829ee6d5557c0011`	string
image_name optional	Image name Example : `RHEL 8.8 for BM`	string
name optional	Server name Example : `baremetal-01`	string
srn optional	SRN Example : `srn:dev2::36827d9b643f46c2ae6bb7e63d633bfe:kr-west1::baremetal-blockstorage:volume/97cd36e3c1984c8cad3ec193aeda25e0`	string
state optional	Server state Example : `RUNNING`	string
type optional	Server type Example : `BM`	enum (BM, MNGC)

2.3 - AttachmentListModel

Name	Description	Schema	Default
object_id optional	Object id Example : `83c3c73d457345e3829ee6d5557c0016`	string
object_type optional	Object type Example : `BM`	enum (BM, MNGC)

2.4 - ExternalError

Name	Description	Schema
code optional	Code Example : `Forbidden`	string
object_type optional	Server type Example : `BM`	enum (BM, MNGC)
status optional	Status Example : `403`	integer

2.5 - MemberVolume

Name	Description	Schema
disk_type optional	disk_type Example : `SSD`	enum (SSD, HDD)
id optional	volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string
name optional	volume name Example : `volume-01`	string
purpose optional	volume purpose Example : `ORG`	enum (ORG, REPL, BACKUP, RECOVERY)
size_gb optional	size_gb Example : `10`	integer
so_volume_id optional	so volume id Example :	string
so_volume_name optional	so volume name Example :	string

2.6 - MemberVolumeWithRecoveryInfo

Name	Description	Schema
disk_type optional	Disk type Example : `SSD`	enum (SSD, HDD)
id optional	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string
name optional	Volume name Example : `bs-01`	string
origin_volume optional	origin volume information	SimpleIdNameInfo
recovery_volume optional	recovery volume information	SimpleIdNameInfo
size_gb optional	Volume capacity(GB) Example : `10`	integer
snapshot_rate optional	Snapshot rate Example : `100`	integer
state optional	Current state Example : `CREATING`	enum (CREATING, IN_USE, EDITING, DELETING, DELETED, ATTACHING, DETACHING, AVAILABLE, ERROR_DELETING, ERROR_EDITING, ERROR)

2.7 - QoSModel

Name	Description	Schema	Default
iops required	Enter the value between at least 5,000 IOPS and up to 20,000 IOPS. Example : `5000`	integer
throughput required	Enter the value between at least 250MB/s and up to 1,000MB/s. Example : `250`	integer

2.8 - RecoveryInfo

Name	Description	Schema	Default
origin_volume optional	origin volume information	RecoveryVolumeInfo
recovery_volume optional	recovery volume information	RecoveryVolumeInfo

2.9 - RecoveryVolumeGroupInfo

Name	Description	Schema	Default
origin_volume_group optional	Origin volume group information	SimpleIdNameInfo
recovery_volume_group optional	Recovery volume group information	SimpleIdNameInfo

2.10 - RecoveryVolumeInfo

Name	Description	Schema
attachments optional	Attached server	array[SimpleAttachedServer]
id optional	id Example : `7239779c01e3405f82bb71c7f4b55fcd`	string
name optional	Volume name Example : `bs-01`	string

2.11 - RelationVolumeGroupModel

Name	Description	Schema
auth optional	Auth Example : `READ`	enum (READ, READ_WRITE, UNKNOWN)
id optional	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string
name optional	Volume name Example : `bs-01`	string
purpose optional	Volume group purpose Example : `ORG`	enum (ORG, REPL, RECOVERY)
region optional	Region Example : `kr-west1`	string

2.12 - RelationVolumeModel

Name	Description	Schema
auth optional	Auth Example : `READ`	enum (READ, READ_WRITE, UNKNOWN)
id optional	id Example : `7239779c01e3405f82bb71c7f4b55fcd`	string
name optional	Volume name Example : `bs-01`	string
purpose optional	Volume purpose Example : `ORG`	enum (ORG, REPL, BACKUP, RECOVERY)
region optional	Region Example : `kr-west1`	string

2.13 - SetVolumeQoSRequest

Name	Description	Schema	Default
iops optional	IOPS. If omitted, the existing value will be retained. Example : `5000`	integer
throughput optional	Throughput. If omitted, the existing value will be retained. Example : `250`	integer

2.14 - SetVolumeQoSResponse

Name	Description	Schema	Default
iops optional	IOPS Example : `5000`	integer
throughput optional	Throughput Example : `250`	integer

2.15 - SimpleAttachedServer

Name	Description	Schema	Default
id optional	Server id Example : `83c3c73d457345e3829ee6d5557c0011`	string
type optional	Server type Example : `BM`	enum (BM, MNGC)

2.16 - SimpleIdNameInfo

Name	Description	Schema	Default
id optional	id Example : `7239779c01e3405f82bb71c7f4b55fcd`	string
name optional	name Example : `my_name`	string

2.17 - SnapshotSchedule

Name	Description	Schema	Default
day_of_week optional	Day of week Example : `MON`	string	MON
frequency optional	Frequency DAILY	WEEKLY	NONE Example : `DAILY`
hour optional	Hour Example : `18`	integer

2.18 - TagModel

Name	Description	Schema	Default
key optional	Tag key Example : `my_tag_1`	any of [string, null]
value optional	Tag value Example : `my_value_1`	any of [string, null]

2.19 - VolumeAttachmentRequest

Name	Description	Schema	Default
attachments required	List of server id and type	array[AttachmentListModel]

2.20 - VolumeAttachmentResponse

Name	Description	Schema	Default
attachments optional	List of server id and type	array[AttachmentListModel]

2.21 - VolumeCreateRequest

Name	Description	Schema
attachments required	List of server id and type	array[AttachmentListModel]
disk_type required	Disk type Example : `SSD`	enum (SSD, HDD)
name required	Volume name Example : `bs-01`	string
size_gb required	Volume capacity(GB) Example : `10`	integer
tags optional	Tags	any of [array[TagModel], null]

2.22 - VolumeCreateRequestV1Dot2

Name	Description	Schema
attachments required	List of server id and type	array[AttachmentListModel]
disk_type required	Disk type Example : `SSD`	enum (SSD, HDD)
name required	Volume name Example : `bs-01`	string
qos optional	Volume QoS	QoSModel
size_gb required	Volume capacity(GB) Example : `10`	integer
tags optional	Tags	any of [array[TagModel], null]

2.23 - VolumeDetachRequest

Name	Description	Schema	Default
attachments required	List of object id to detach	array[string]

2.24 - VolumeGroupCreationRequest

Name	Description	Schema
name required	Volume group name Example : `vg-01`	string
tags optional	Tags	any of [array[TagModel], null]
volume_ids required	List of volume(Block Storage) id to add Example : `['17e0b4fd27784dfb843440ec08bdd148']`	array[string]

2.25 - VolumeGroupInfo

Name	Description	Schema	Default
id optional	id Example : `7239779c01e3405f82bb71c7f4b55fcd`	string
name optional	Volume group name Example : `vg-01`	string

2.26 - VolumeGroupListModel

Name	Description	Schema	Default
account_id optional	Account id Example : `36827d9b643f46c2ae6bb7e63d633bfe`	string
created_at optional	Created at Example : `2024-08-01T07:06:23.315Z`	string (date-time)
created_by optional	Created by Example : `samsung-cloud-platform1@samsung.com`	string
id optional	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string
modified_at optional	Modified at Example : `2024-08-01T07:06:25.315Z`	string (date-time)
modified_by optional	Modified by Example : `samsung-cloud-platform2@samsung.com`	string
name optional	Volume group name Example : `vg-01`	string
num_of_block_storages optional	Number of volumes Example : `2`	integer	1
purpose optional	Volume group purpose Example : `ORG`	string
state optional	Current state Example : `CREATING`	enum (CREATING, AVAILABLE, DELETING, EDITING, DELETED, ERROR_DELETING, ERROR_EDITING, ERROR)

2.27 - VolumeGroupListResponse

Name	Description	Schema	Default
total_count optional	Total count Example : `1`	integer
volume_groups optional	List of volume groups	array[VolumeGroupListModel]

2.28 - VolumeGroupMemberRequest

Name	Description	Schema	Default
volume_ids required	List of volume(Block Storage) id Example : `['13666d6c32d4456e8421f7768d0bf225']`	array[string]

2.29 - VolumeGroupMemberResponse

Name	Description	Schema	Default
id optional	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string
member_volumes optional	List of member volumes	array[MemberVolume]

2.30 - VolumeGroupModel

Name	Description	Schema
account_id optional	Account id Example : `36827d9b643f46c2ae6bb7e63d633bfe`	string
created_at optional	Created at Example : `2024-08-01T07:06:23.315Z`	string
created_by optional	Created by Example : `samsung-cloud-platform1@samsung.com`	string
has_origin optional	Whether origin relation exists Example : `True`	boolean
has_replication optional	Whether replication relation exists Example : `True`	boolean
id optional	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string
member_volumes optional	List of member volumes	array[MemberVolumeWithRecoveryInfo]
modified_at optional	Modified at Example : `2024-08-01T07:06:25.315Z`	string
modified_by optional	Modified by Example : `samsung-cloud-platform2@samsung.com`	string
name optional	Volume group name Example : `vg-01`	string
purpose optional	Volume group purpose Example : `ORG`	enum (ORG, REPL, RECOVERY)
recovery optional	Recovery volume group information	RecoveryVolumeGroupInfo
snapshot_schedule optional	Snapshot schedule	SnapshotSchedule
so_storage_id optional	So Storage Id Example : `200`	integer
so_volume_pool_id optional	So Volume pool id Example : `bm-01`	string
state optional	Current state Example : `CREATING`	enum (CREATING, AVAILABLE, DELETING, EDITING, DELETED, ERROR_DELETING, ERROR_EDITING, ERROR)
storage_volume_group_name optional	So volume group name Example : `go02407310544da8aadc775f`	string

2.31 - VolumeGroupRecoveryCreateRequest

Name	Description	Schema	Default
block_storage_name_prefix required	Block Storage name prefix Example : `prefix-`	string
snapshot_id required	Snapshot id Example : `05600123-6e78-11f0-a3f0-d039eab8d501`	string

2.32 - VolumeGroupReplicationCreateRequest

Name	Description	Schema
cycle required	Replication cycle Example : `5MIN`	enum (5MIN, HOURLY, DAILY, WEEKLY, MONTHLY)
name required	Replication volume group name Example : `replica-vg-01`	string
region required	Region Example : `kr-west1`	string
replication_volume_name_prefix required	Replication volume name prefix Example : `dr`	string

2.33 - VolumeGroupReplicationDeleteResponse

Name	Description	Schema	Default
result optional	Result Example :	boolean

2.34 - VolumeGroupReplicationSyncModelV1Dot3

Name	Description	Schema
lag_time optional	Lag Time(elapsed delay between the original’s latest snapshot and its newest copy on the replication volume) Example : `01:23:45`	string
related_volume_groups optional	List of related volume groups	array[RelationVolumeGroupModel]
sync_cycle optional	Replication cycle Example : `5MIN`	enum (5MIN, HOURLY, DAILY, WEEKLY, MONTHLY)
sync_state optional	Replication state Example : `SNAPMIRROED`	string

2.35 - VolumeGroupReplicationSyncResponseV1Dot3

Name	Description	Schema	Default
result optional	Volume group replication detail	VolumeGroupReplicationSyncModelV1Dot3

2.36 - VolumeGroupReplicationSyncTabModel

Name	Description	Schema
related_volume_groups optional	List of related volume groups	array[RelationVolumeGroupModel]
sync_cycle optional	Replication cycle Example : `5MIN`	enum (5MIN, HOURLY, DAILY, WEEKLY, MONTHLY)
sync_state optional	Replication state Example : `SNAPMIRROED`	string

2.37 - VolumeGroupReplicationSyncTabResponse

Name	Description	Schema	Default
result optional	Volume group replication detail	VolumeGroupReplicationSyncTabModel

2.38 - VolumeGroupReplicationUpdateCycleRequest

Name	Description	Schema	Default
cycle required	Replication cycle Example : `5MIN`	enum (5MIN, HOURLY, DAILY, WEEKLY, MONTHLY)

2.39 - VolumeGroupReplicationUpdateCycleResponse

Name	Description	Schema	Default
cycle optional	Replication cycle Example : `5MIN`	enum (5MIN, HOURLY, DAILY, WEEKLY, MONTHLY)
volume_group_id optional	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string

2.40 - VolumeGroupReplicationUpdatePolicyRequest

Name	Description	Schema	Default
policy required	Policy Example : `RESYNC`	enum (RESYNC, BREAK)

2.41 - VolumeGroupReplicationUpdatePolicyResponse

Name	Description	Schema	Default
cycle optional	Replication cycle Example : `5MIN`	enum (5MIN, HOURLY, DAILY, WEEKLY, MONTHLY)
sync_state optional	Replication state Example : `SNAPMIRROED`	string

2.42 - VolumeGroupResponse

Name	Description	Schema	Default
result optional	Volume group detail	VolumeGroupModel

2.43 - VolumeGroupSnapshotDeleteResponse

Name	Description	Schema
account_id optional	Account id Example : `36827d9b643f46c2ae6bb7e63d633bfe`	string
snapshot_id optional	Snapshot id Example : `05600123-6e78-11f0-a3f0-d039eab8d501`	string
volume_group_id optional	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string

2.44 - VolumeGroupSnapshotListModel

Name	Description	Schema
created_dt optional	Created dt Example : `2024-08-01T07:07:23.315Z`	string
snapshot_id optional	Snapshot id Example : `05600123-6e78-11f0-a3f0-d039eab8d501`	string
snapshot_name optional	Snapshot name Example : `vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932`	string

2.45 - VolumeGroupSnapshotListResponse

Name	Description	Schema
is_snapshot_policy optional	Whether to activate snapshot Example : `False`	boolean
snapshots optional	List of snapshots	array[VolumeGroupSnapshotListModel]
volume_group_id optional	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string

2.46 - VolumeGroupSnapshotResponse

Name	Description	Schema
account_id optional	Account id Example : `36827d9b643f46c2ae6bb7e63d633bfe`	string
snapshot_id optional	Snapshot id Example : `05600123-6e78-11f0-a3f0-d039eab8d501`	string
snapshot_name optional	Snapshot name Example : `vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932`	string
volume_group_id optional	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string

2.47 - VolumeGroupSnapshotRestoreResponse

Name	Description	Schema
account_id optional	Account id Example : `36827d9b643f46c2ae6bb7e63d633bfe`	string
snapshot_id optional	Snapshot id Example : `05600123-6e78-11f0-a3f0-d039eab8d501`	string
volume_group_id optional	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string

2.48 - VolumeGroupSnapshotScheduleRequest

Name	Description	Schema	Default
day_of_week optional	Day of week(If this field is excluded, the schedule frequency is set to DAILY.) Example : `SUN`	enum (SUN, MON, TUE, WED, THU, FRI, SAT)
hour required	Hour Example : `18`	integer

2.49 - VolumeGroupSnapshotScheduleResponse

Name	Description	Schema	Default
day_of_week optional	Day of week Example : `SUN`	enum (SUN, MON, TUE, WED, THU, FRI, SAT)
frequency optional	Frequency DAILY	WEEKLY	NONE Example : `DAILY`
hour optional	Hour Example : `18`	integer
volume_group_id optional	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string

2.50 - VolumeListModel

Name	Description	Schema
attachments optional	Attached server Example : `[{'id': 'd7682135392e42489948c189e29011cc', 'name': 'baremetal-01'}]`	array[object]
created_at optional	Created at Example :	string (date-time)
created_by optional	Created by Example : `samsung-cloud-platform1@samsung.com`	string
disk_type optional	Disk type Example : `SSD`	enum (SSD, HDD)
has_relation optional	Whether relation exists Example : `False`	boolean
id optional	id Example : `7239779c01e3405f82bb71c7f4b55fcd`	string
is_in_volume_group optional	Whether to belong to the volume group Example : `False`	boolean
is_snapshot_activated optional	Whether to activate snapshot Example : `True`	boolean
iscsi_target_ips optional	List of iscsi ips Example : `{'description': 'List of iscsi ips', 'example': ['172.30.4.3', '172.30.4.4']}`	array[string]
modified_at optional	Modified at Example :	string (date-time)
modified_by optional	Modified by Example : `samsung-cloud-platform2@samsung.com`	string
name optional	Volume name Example : `bs-01`	string
purpose optional	Volume purpose Example : `ORG`	enum (ORG, REPL, BACKUP, RECOVERY)
size_gb optional	Volume capacity(GB) Example : `10`	integer
state optional	Current state Example : `CREATING`	enum (CREATING, IN_USE, EDITING, DELETING, DELETED, ATTACHING, DETACHING, AVAILABLE, ERROR_DELETING, ERROR_EDITING, ERROR)
volume_group optional	Volume group Example :	object

2.51 - VolumeListResponse

Name	Description	Schema	Default
total_count optional	Total count Example : `1`	integer
volumes optional	List of volumes	array[VolumeListModel]

2.52 - VolumeModel

Name	Description	Schema
account_id optional	Account id Example : `36827d9b643f46c2ae6bb7e63d633bfe`	string
attachments optional	Attached server	array[AttachedServer]
created_at optional	Created at Example : `2024-08-01T07:06:23.315Z`	string
created_by optional	Created by Example : `samsung-cloud-platform1@samsung.com`	string
disk_type optional	Disk type Example : `SSD`	enum (SSD, HDD)
external_errors optional	Error during external call	array[ExternalError]
has_origin optional	Whether origin relation exists Example : `True`	boolean
has_replication optional	Whether replication relation exists Example : `True`	boolean
id optional	id Example : `7239779c01e3405f82bb71c7f4b55fcd`	string
is_encryption optional	Whether to apply encryption Example : `True`	boolean
iscsi_target_ips optional	List of iscsi ips Example : `['172.30.4.3', '172.30.4.4']`	array[string]
modified_at optional	Modified at Example : `2024-08-01T07:06:25.315Z`	string
modified_by optional	Modified by Example : `samsung-cloud-platform2@samsung.com`	string
name optional	Volume name Example : `bs-01`	string
previous_state optional	Previous state Example : `CREATING`	enum (CREATING, IN_USE, EDITING, DELETING, DELETED, ATTACHING, DETACHING, AVAILABLE, ERROR_DELETING, ERROR_EDITING, ERROR)
purpose optional	Volume purpose Example : `ORG`	enum (ORG, REPL, BACKUP, RECOVERY)
recovery optional	Recovery information	RecoveryInfo
size_gb optional	Volume capacity(GB) Example : `10`	integer
snapshot_rate optional	Snapshot rate Example : `100`	integer
snapshot_schedule optional	Snapshot schedule	SnapshotSchedule
srn optional	SRN Example : `srn:dev2::36827d9b643f46c2ae6bb7e63d633bfe:kr-west1::baremetal-blockstorage:volume/97cd36e3c1984c8cad3ec193aeda25e0`	string
state optional	Current state Example : `CREATING`	enum (CREATING, IN_USE, EDITING, DELETING, DELETED, ATTACHING, DETACHING, AVAILABLE, ERROR_DELETING, ERROR_EDITING, ERROR)
storage_volume_name optional	Storage volume name Example : `vo202407310544da8aadc775f`	string
volume_group optional	Volume group	VolumeGroupInfo

2.53 - VolumeModelV1Dot2

Name	Description	Schema
account_id optional	Account id Example : `36827d9b643f46c2ae6bb7e63d633bfe`	string
attachments optional	Attached server	array[AttachedServer]
created_at optional	Created at Example : `2024-08-01T07:06:23.315Z`	string
created_by optional	Created by Example : `samsung-cloud-platform1@samsung.com`	string
disk_type optional	Disk type Example : `SSD`	enum (SSD, HDD)
external_errors optional	Error during external call	array[ExternalError]
has_origin optional	Whether origin relation exists Example : `True`	boolean
has_replication optional	Whether replication relation exists Example : `True`	boolean
id optional	id Example : `7239779c01e3405f82bb71c7f4b55fcd`	string
is_encryption optional	Whether to apply encryption Example : `True`	boolean
iscsi_target_ips optional	List of iscsi ips Example : `['172.30.4.3', '172.30.4.4']`	array[string]
modified_at optional	Modified at Example : `2024-08-01T07:06:25.315Z`	string
modified_by optional	Modified by Example : `samsung-cloud-platform2@samsung.com`	string
name optional	Volume name Example : `bs-01`	string
previous_state optional	Previous state Example : `CREATING`	enum (CREATING, IN_USE, EDITING, DELETING, DELETED, ATTACHING, DETACHING, AVAILABLE, ERROR_DELETING, ERROR_EDITING, ERROR)
purpose optional	Volume purpose Example : `ORG`	enum (ORG, REPL, BACKUP, RECOVERY)
qos optional	Volume QoS	QoSModel
recovery optional	Recovery information	RecoveryInfo
size_gb optional	Volume capacity(GB) Example : `10`	integer
snapshot_rate optional	Snapshot rate Example : `100`	integer
snapshot_schedule optional	Snapshot schedule	SnapshotSchedule
srn optional	SRN Example : `srn:dev2::36827d9b643f46c2ae6bb7e63d633bfe:kr-west1::baremetal-blockstorage:volume/97cd36e3c1984c8cad3ec193aeda25e0`	string
state optional	Current state Example : `CREATING`	enum (CREATING, IN_USE, EDITING, DELETING, DELETED, ATTACHING, DETACHING, AVAILABLE, ERROR_DELETING, ERROR_EDITING, ERROR)
storage_volume_name optional	Storage volume name Example : `vo202407310544da8aadc775f`	string
volume_group optional	Volume group	VolumeGroupInfo

2.54 - VolumeRecoveryCreateRequest

Name	Description	Schema	Default
name required	Recovery volume name Example : `recovery-volume`	string
snapshot_id required	Snapshot id Example : `05600123-6e78-11f0-a3f0-d039eab8d501`	string

2.55 - VolumeReplicationCreateRequest

Name	Description	Schema
cycle required	Replication cycle Example : `5MIN`	enum (5MIN, HOURLY, DAILY, WEEKLY, MONTHLY)
name required	Replication volume name Example : `replica-bs-01`	string
region required	Region Example : `kr-west1`	string

2.56 - VolumeReplicationCycleRequest

Name	Description	Schema	Default
cycle required	Replication cycle Example : `5MIN`	enum (5MIN, HOURLY, DAILY, WEEKLY, MONTHLY)

2.57 - VolumeReplicationCycleResponse

Name	Description	Schema	Default
cycle optional	Replication cycle Example : `5MIN`	enum (5MIN, HOURLY, DAILY, WEEKLY, MONTHLY)
volume_id optional	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string

2.58 - VolumeReplicationModel

Name	Description	Schema
related_volumes optional	List of related volumes	array[RelationVolumeModel]
sync_cycle optional	Replication cycle Example : `5MIN`	enum (5MIN, HOURLY, DAILY, WEEKLY, MONTHLY)
sync_state optional	Replication state Example : `SNAPMIRROED`	string

2.59 - VolumeReplicationModelV1Dot3

Name	Description	Schema
lag_time optional	Lag Time(elapsed delay between the original’s latest snapshot and its newest copy on the replication volume) Example : `01:23:45`	string
related_volumes optional	List of related volumes	array[RelationVolumeModel]
sync_cycle optional	Replication cycle Example : `5MIN`	enum (5MIN, HOURLY, DAILY, WEEKLY, MONTHLY)
sync_state optional	Replication state Example : `SNAPMIRROED`	string

2.60 - VolumeReplicationPolicyRequest

Name	Description	Schema	Default
policy required	Policy Example : `RESYNC`	enum (RESYNC, BREAK)

2.61 - VolumeReplicationPolicyResponse

Name	Description	Schema	Default
sync_cycle optional	Replication cycle Example : `5MIN`	enum (5MIN, HOURLY, DAILY, WEEKLY, MONTHLY)
sync_state optional	Replication state Example : `SNAPMIRROED`	string

2.62 - VolumeReplicationResponse

Name	Description	Schema	Default
result optional	Volume replication detail	VolumeReplicationModel

2.63 - VolumeReplicationResponseV1Dot3

Name	Description	Schema	Default
result optional	Volume replication detail	VolumeReplicationModelV1Dot3

2.64 - VolumeResponse

Name	Description	Schema	Default
result optional	Volume detail	VolumeModel

2.65 - VolumeResponseV1Dot2

Name	Description	Schema	Default
result optional	Volume detail	VolumeModelV1Dot2

2.66 - VolumeSnapshotDeleteResponse

Name	Description	Schema
account_id optional	Account id Example : `36827d9b643f46c2ae6bb7e63d633bfe`	string
snapshot_id optional	Snapshot id Example : `05600123-6e78-11f0-a3f0-d039eab8d501`	string
volume_id optional	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string

2.67 - VolumeSnapshotListModel

Name	Description	Schema
created_dt optional	Created dt Example : `2024-08-01T07:07:23.315Z`	string
snapshot_id optional	Snapshot id Example : `05600123-6e78-11f0-a3f0-d039eab8d501`	string
snapshot_name optional	Snapshot name Example : `vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932`	string
snapshot_size_mb optional	Snapshot size(MB) Example : `0`	object

2.68 - VolumeSnapshotListResponse

Name	Description	Schema
is_snapshot_policy optional	Whether to activate snapshot Example : `False`	boolean
snapshot_capacity_mb optional	Snapshot size(MB) Example : `0`	object
snapshot_capacity_rate optional	Snapshot capacity rate Example : `0`	object
snapshot_total_usage optional	Snapshot total usage Example : `0`	object
snapshots optional	List of snapshots	array[VolumeSnapshotListModel]
volume_id optional	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string

2.69 - VolumeSnapshotRateRequest

Name	Description	Schema	Default
snapshot_rate required	Snapshot rate Example : `100`	integer

2.70 - VolumeSnapshotRateResponse

Name	Description	Schema
is_snapshot_activated optional	Whether to activate snapshot Example : `True`	boolean
snapshot_rate optional	Snapshot rate Example : `100`	integer
volume_id optional	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string

2.71 - VolumeSnapshotResponse

Name	Description	Schema
account_id optional	Account id Example : `36827d9b643f46c2ae6bb7e63d633bfe`	string
snapshot_id optional	Snapshot id Example : `05600123-6e78-11f0-a3f0-d039eab8d501`	string
snapshot_name optional	Snapshot name Example : `vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932`	string
volume_id optional	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string

2.72 - VolumeSnapshotRestoreResponse

Name	Description	Schema
account_id optional	Account id Example : `36827d9b643f46c2ae6bb7e63d633bfe`	string
snapshot_id optional	Snapshot id Example : `05600123-6e78-11f0-a3f0-d039eab8d501`	string
volume_id optional	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string

2.73 - VolumeSnapshotScheduleRequest

Name	Description	Schema	Default
day_of_week optional	Day of week(If this field is excluded, the schedule frequency is set to DAILY.) Example : `SUN`	enum (SUN, MON, TUE, WED, THU, FRI, SAT)
hour required	Hour Example : `18`	integer

2.74 - VolumeSnapshotScheduleResponse

Name	Description	Schema	Default
day_of_week optional	Day of week Example : `SUN`	enum (SUN, MON, TUE, WED, THU, FRI, SAT)
frequency optional	Frequency DAILY	WEEKLY	NONE Example : `DAILY`
hour optional	Hour Example : `18`	integer
volume_id optional	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string