Create Shared Folder

URI

POST

https://{api_host}/api/vms/{id}/sharedfolders

COPY

Path Parameters

string

id

Required

ID of VM

---

Request Body

Parameters of the shared folder to mount

SharedFolder of type(s) application/vnd.vmware.vmw.rest-v1+json

Required

{
    "folder_id": "string",
    "host_path": "string",
    "flags": 0
}

string

folder_id

Required

ID of folder which be mounted to the host

string

host_path

Required

Path of the host shared folder

integer

flags

Required

The flags property specifies how the folder will be accessed by the VM. There is only one flag supported which is "4" and means read/write access.

Responses

201

Hide Details

Shared folders mounted in the VM

Returns Array of SharedFolders of type(s) application/vnd.vmware.vmw.rest-v1+json

"SharedFolders Object"

400

Hide Details

Invalid parameters

Returns ErrorModel of type(s) application/vnd.vmware.vmw.rest-v1+json

"ErrorModel Object"

integer As int32 As int32

code

Required

code

string

message

Required

message

401

Hide Details

Authentication failed

Returns ErrorModel of type(s) application/vnd.vmware.vmw.rest-v1+json

"ErrorModel Object"

integer As int32 As int32

code

Required

code

string

message

Required

message

403

Hide Details

Permission denied

Returns ErrorModel of type(s) application/vnd.vmware.vmw.rest-v1+json

"ErrorModel Object"

integer As int32 As int32

code

Required

code

string

message

Required

message

404

Hide Details

No such resource

Returns ErrorModel of type(s) application/vnd.vmware.vmw.rest-v1+json

"ErrorModel Object"

integer As int32 As int32

code

Required

code

string

message

Required

message

406

Hide Details

Content type was not supported

Returns ErrorModel of type(s) application/vnd.vmware.vmw.rest-v1+json

"ErrorModel Object"

integer As int32 As int32

code

Required

code

string

message

Required

message

409

Hide Details

Resource state conflicts

Returns ErrorModel of type(s) application/vnd.vmware.vmw.rest-v1+json

"ErrorModel Object"

integer As int32 As int32

code

Required

code

string

message

Required

message

500

Hide Details

Server error

Returns ErrorModel of type(s) application/vnd.vmware.vmw.rest-v1+json

"ErrorModel Object"

integer As int32 As int32

code

Required

code

string

message

Required

message

default

Hide Details

Unexpected error

Returns ErrorModel of type(s) application/vnd.vmware.vmw.rest-v1+json

"ErrorModel Object"

integer As int32 As int32

code

Required

code

string

message

Required

message

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/vnd.vmware.vmw.rest-v1+json' -d '{"folder_id:"string","host_path:"string","flags:"integer"}' https://{api_host}/api/vms/{id}/sharedfolders