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

Return to the regular view of this page.

List Server Volumes

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

1 - 1.3

get /v1/servers/{server_id}/volumes

Description

List Server Volumes.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

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

Responses

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

Example HTTP request

Request path

/v1/servers/{server_id}/volumes

Request header

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

Example HTTP response

Response 200

{
    "volumes": [
        {
            "delete_on_termination": false,
            "device": "/dev/vda",
            "id": "3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c",
            "server_id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
            "volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
        }
    ]
}

2 - 1.2

get /v1/servers/{server_id}/volumes

Description

List Server Volumes.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

Parameters

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

Responses

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

Example HTTP request

Request path

/v1/servers/{server_id}/volumes

Request header

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

Example HTTP response

Response 200

{
    "volumes": [
        {
            "delete_on_termination": false,
            "device": "/dev/vda",
            "id": "3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c",
            "server_id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
            "volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
        }
    ]
}

3 - 1.1

get /v1/servers/{server_id}/volumes

Description

List Server Volumes.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260531

Parameters

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

Responses

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

Example HTTP request

Request path

/v1/servers/{server_id}/volumes

Request header

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

Example HTTP response

Response 200

{
    "volumes": [
        {
            "delete_on_termination": false,
            "device": "/dev/vda",
            "id": "3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c",
            "server_id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
            "volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
        }
    ]
}

4 - 1.0

get /v1/servers/{server_id}/volumes

Description

List Server Volumes.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

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

Responses

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

Example HTTP request

Request path

/v1/servers/{server_id}/volumes

Request header

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

Example HTTP response

Response 200

{
    "volumes": [
        {
            "delete_on_termination": false,
            "device": "/dev/vda",
            "id": "3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c",
            "server_id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
            "volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
        }
    ]
}