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

Return to the regular view of this page.

Create a volume transfer

1 - 1.3

post /v1/volume-transfer

Description

Create a volume transfer.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

VolumeTransferRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedVolumeTransferCreateResponse
400Bad RequestNone
401UnauthorizedNone

Example HTTP request

Request path

/v1/volume-transfer

Request header

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

Request body

{
    "name": "volume01",
    "volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}

Example HTTP response

Response 202

{
    "auth_key": "f5972fdb456897eb",
    "created_at": "",
    "id": "1ac231be-823b-4a4d-8ff0-aac503a7118a",
    "name": "volume01",
    "volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}

2 - 1.2

post /v1/volume-transfer

Description

Create a volume transfer.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

VolumeTransferRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedVolumeTransferCreateResponse
400Bad RequestNone
401UnauthorizedNone

Example HTTP request

Request path

/v1/volume-transfer

Request header

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

Request body

{
    "name": "volume01",
    "volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}

Example HTTP response

Response 202

{
    "auth_key": "f5972fdb456897eb",
    "created_at": "",
    "id": "1ac231be-823b-4a4d-8ff0-aac503a7118a",
    "name": "volume01",
    "volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}

3 - 1.1

post /v1/volume-transfer

Description

Create a volume transfer.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.120260531

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

VolumeTransferRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedVolumeTransferCreateResponse
400Bad RequestNone
401UnauthorizedNone

Example HTTP request

Request path

/v1/volume-transfer

Request header

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

Request body

{
    "name": "volume01",
    "volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}

Example HTTP response

Response 202

{
    "auth_key": "f5972fdb456897eb",
    "created_at": "",
    "id": "1ac231be-823b-4a4d-8ff0-aac503a7118a",
    "name": "volume01",
    "volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}

4 - 1.0

post /v1/volume-transfer

Description

Create a volume transfer.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

VolumeTransferRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedVolumeTransferCreateResponse
400Bad RequestNone
401UnauthorizedNone

Example HTTP request

Request path

/v1/volume-transfer

Request header

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

Request body

{
    "name": "volume01",
    "volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}

Example HTTP response

Response 202

{
    "auth_key": "f5972fdb456897eb",
    "created_at": "",
    "id": "1ac231be-823b-4a4d-8ff0-aac503a7118a",
    "name": "volume01",
    "volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}