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

Return to the regular view of this page.

Attach Volume to Virtual Server

1: 1.3
2: 1.2
3: 1.1
4: 1.0

1 - 1.3

post /v1/volumes/{volume_id}/servers

Description

Attach Volume to Virtual Server.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume ID Example : `3f500f00-ed80-4566-a057-e31760226f9a`	string	None
body	body required		VolumeServerAttachRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/servers

Request header

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

Request body

{
    "delete_on_termination": false,
    "server_id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
}

Example HTTP response

Response 202

{
    "delete_on_termination": false,
    "device": "/dev/vda",
    "server_id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
    "volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}

2 - 1.2

post /v1/volumes/{volume_id}/servers

Description

Attach Volume to Virtual Server.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume ID Example : `3f500f00-ed80-4566-a057-e31760226f9a`	string	None
body	body required		VolumeServerAttachRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/servers

Request header

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

Request body

{
    "delete_on_termination": false,
    "server_id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
}

Example HTTP response

Response 202

{
    "delete_on_termination": false,
    "device": "/dev/vda",
    "server_id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
    "volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}

3 - 1.1

post /v1/volumes/{volume_id}/servers

Description

Attach Volume to Virtual Server.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260531

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume ID Example : `3f500f00-ed80-4566-a057-e31760226f9a`	string	None
body	body required		VolumeServerAttachRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/servers

Request header

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

Request body

{
    "delete_on_termination": false,
    "server_id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
}

Example HTTP response

Response 202

{
    "delete_on_termination": false,
    "device": "/dev/vda",
    "server_id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
    "volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}

4 - 1.0

post /v1/volumes/{volume_id}/servers

Description

Attach Volume to Virtual Server.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	Volume ID Example : `3f500f00-ed80-4566-a057-e31760226f9a`	string	None
body	body required		VolumeServerAttachRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/servers

Request header

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

Request body

{
    "delete_on_termination": false,
    "server_id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
}

Example HTTP response

Response 202

{
    "delete_on_termination": false,
    "device": "/dev/vda",
    "server_id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
    "volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}