Introduction

Logical Folders are containers for storing and organizing inventory objects, in this case virtual machines. As Just like the network resource, a Folder has a Managed Object Reference (moref) which is required for either virtual machine deployment (where a virtual machine will be placed upon creation) or updating virtual machine containing folder (movedmove).

The /v2/folder resource lists folders you are allowed to access in our environment. If by any chance you cannot see a folder and you add it to a new virtual machine creation request or a virtual machine change request, they will not be successfully processed. If you believe you need access to a specific folder, please let us know.

Panel

On this page:

Table of Contents

maxLevel	2
outline	true

The following table shows a brief description and HTTP methods allowed to interact with logical folders.

Resource	URI	Description	GET	POST	PUT	PATCH	OPTIONS
Folder	/folder	Logical Folder Management resource. List permitted folders and their attributes

Note

title	OPTIONS HTTP method

Remember, you can also show what methods are allowed and method description, parameters, etc. by making an OPTIONS HTTP request to /v2/folder.

Code Block

language	bash

http OPTIONS "https://vss-api.eis.utoronto.ca:8001/v2/folder"
curl -X OPTIONS "https://vss-api.eis.utoronto.ca:8001/v2/folder"

List

In order to list allowed Folders you should make a GET request to the endpoint /v2/folder, passing your access token. As a result, you will get a reference URI /v2/folder/<moref> to get detailed information about that folder, human readable name and Managed Object Reference (moref).

Name	Type	Description
name	string	Folder name.
parent	string	Parent folder name.
moref	string	vCenter Managed Object Reference (moref)
_links	array	List of URIs related to the resource.
full_path	string	vCenter full path to the folder

The following examples implements HTTPie and CURL to list all folders a user have access to:

Code Blockhttp -a $TK GET "https://


Folder Object	/folder/<moref>	Get logical folder attributes.
Folder Name	/folder/<moref>/name	Rename object.
Folder Children	/folder/<moref>/children	Get children folders if any.
Folder Parent	/folder/<moref>/parent	Get or move folder to a different parent.
Folder VMs	/folder/<moref>/vm	List children virtual machines.
Folder Permission	/folder/<moref>/permission	List object permission.

Note

TK stores the Cloud API Token generated as a result of the following POST request to the /auth/request-token resource:

Code Block
curl -X POST https://vss-api.eis.utoronto.ca/auth/request-token -u <username>

For example, extracting the token with the jq command:

Code Block
TK=$(curl -X POST https://vss-api.eis.utoronto.ca

:8001

v2/folder" curl

auth/request-token -u <username>

$TK

| jq -

X GET "

r '.token')

List

In order to list allowed Folders you should make a GET request to the endpoint /v2/folder, passing your access token. As a result, you will get a reference URI /v2/folder/<moref> to get detailed information about that folder.

Code Block
http GET "https://vss-api.eis.utoronto.ca:8001/v2/folder" "Authorization: Bearer $TK" curl -H "Authorization: Bearer $TK" -X GET "https://vss-api.eis.utoronto.ca/v2/folder"

The following examples implements HTTPie and CURL to list all folders a user have access to:

Code Block

language	py
title	Response Body
collapse	true

{
    "_links": {
        "apiself": "https://vss-api.eis.utoronto.ca:8001/v2/",
        "self": "https://vss-api.eis.utoronto.ca:8001/v2/folderfolder?per_page=3&filter=path,like,%25Testing%25"
    },
    "data": [
        {
            "created_linkson": {
   "2019-07-17 Wed 15:18:59 EDT",
            "selfhas_children": "https://vss-api.eis.utoronto.ca:8001/v2/folder/group-v6736"
            }false,
            "fullhas_pathparent": "VSS > Sandbox > jm > APIDemo"true,
            "moref": "group-v6736v8923",
            "name": "APIDemout20170621092129",
            "parent": "jm"{
        },        "moref": "group-v7350",
   {             "_linksname": {"Testing",
                "selfparent_moref": "https://vss-api.eis.utoronto.ca:8001/v2/folder/group-v6749v7349",
            },             "full_path": "VSS > SandboxDevelopment > jm > DockerDatacenter",Testing",
                "morefvim_type": "group-v6749",vim.Folder"
            "name": "DockerDatacenter"},
            "parent_moref": "jmgroup-v7350"
,
       }     ],
    "meta"path": {"VSS > Development > Testing > ut20170621092129",
  "count": 2,         "timeupdated_on": "0.46083s2019-07-17 Wed 15:18:59 EDT",
        "user    "vim_type": "jmvim.Folder"
        }
}

Filters

This resource has two main filters to narrow down the number of Networks shown in the result.

NameDescriptionnameFolder namemorefvCenter Managed Object Reference (moref)parentParent folder namesummaryDisable folder summary data

The following examples show how to make a GET request, which in both cases, the result would be the same because APIDemo moref contains number 6379.

Code Block

http -a $TK GET "https://vss-api.eis.utoronto.ca:8001/v2/folder?name=API"
http -a $TK GET "https://vss-api.eis.utoronto.ca:8001/v2/folder?moref=6736"
http -a $TK GET "https://vss-api.eis.utoronto.ca:8001/v2/folder?parent=jm"

Code Block

language	py
title	Response Body
collapse	true

{,
        {
            "created_on": "2019-07-17 Wed 15:18:59 EDT",
            "has_children": true,
            "has_linksparent": {true,
            "apimoref": "https://vss-api.eis.utoronto.ca:8001/v2/group-v7350",
            "selfname": "https://vss-api.eis.utoronto.ca:8001/v2/folder"Testing",
    },        "dataparent": [{
        {             "_links": {"moref": "group-v7349",
                "selfname": "https://vss-api.eis.utoronto.ca:8001/v2/folder/group-v6736"Development",
            }     "parent_moref": "group-v305",
                "full_path": "VSS > SandboxDevelopment",
> jm > APIDemo",             "morefvim_type": "group-v6736",vim.Folder"
            "name": "APIDemo"},
            "parent_moref": "jm"
     group-v7349",
  }     ],     "metapath": {"VSS > Development > Testing",
    "count": 1,         "timeupdated_on": "0.46083s",
2019-07-17 Wed 15:18:59 EDT",
       "user     "vim_type": "jmvim.Folder"
        }
}

List specific folder info

Some of the attributes will have an object value. Such is the case of items in attribute vms.

Name	Type	Description
vms	array	Array of Virtual Machines in folder.
vmCount	integer	Number of virtual machines in folder
children	object	Immediate children folders

The following example, requests information about a particular Folder using the base resource /v2/folder and appending the moref to get the URI /v2/folder/group-v6736:

Code Block
http -a $TK GET https://vss-api.eis.utoronto.ca:8001/v2/folder/group-v6736 curl -u $TK -X GET https://vss-api.eis.utoronto.ca:8001/v2/folder/group-v6736

HTTP response body would look something like:

Code Block

language	py
title	Response Body
collapse	true

{
    "_links": {
        "folder": "https://vss-api.eis.utoronto.ca:8001/v2/folder",
        "self": "https://vss-api.eis.utoronto.ca:8001/v2/folder/group-v6736"
    },
    "data": {
        "children": [
            {
                "_links": {
                    "self": "http://localhost:5000/v2/folder/group-v6807"
                },
                "name": "Templates"
            }
        ],
        "name": "APIDemo",
        "parent": "jm",
        "path": "VSS > Sandbox > jm > APIDemo",
        "vmCount": 7,
        "vms": [
            {
                "_links": {
                    "self": "http://localhost:5000/v2/vm/5012ee7a-bbb3-8fdb-c4e9-f87c658e3707"
                },
                "name": "1605T-ecstatic_hopper"
            },
            {
                "_links": {
                    "self": "http://localhost:5000/v2/vm/5012698f-5936-e4f3-c401-803b47aaebae"
                },
                "name": "1605T-condescending_pasteur"
            },
            {
                "_links": {
                    "self": "http://localhost:5000/v2/vm/50126aab-84c4-c532-871b-a431fc47f1e1"
                },
                "name": "1605T-kickass_blackwell"
            },
            {
                "_links": {
                    "self": "http://localhost:5000/v2/vm/50124198-bc0b-add7-aea4-b36c3dc0dc49"
                },
    ,
        {
            "created_on": "2019-07-17 Wed 15:18:59 EDT",
           "name": "1605T-naughtyhas_mcclintockchildren": true,
           },
  "has_parent": true,
          {  "moref": "group-v8900",
             "_linksname": {
        "ut20170135153548",
            "selfparent": "http://localhost:5000/v2/vm/50123bea-a643-755c-cd8a-24bc852ee3c5" {
                 }"moref": "group-v7350",
                "name": "1605T-ecstatic_mcleanTesting",
            },             {"parent_moref": "group-v7349",
                "_linkspath": {"VSS > Development > Testing",
                "selfvim_type": "http://localhost:5000/v2/vm/50126185-ebb2-36ec-bca8-476e51bfe0c8"
   vim.Folder"
            },
                "name": "1605T-kickass_sinoussi"
            },"parent_moref": "group-v7350",
            "path": "VSS > {Development > Testing > ut20170135153548",
            "updated_linkson": {
     "2019-07-17 Wed 15:18:59 EDT",
              "selfvim_type": "http://localhost:5000/v2/vm/5012ea31-b0ae-2975-2e9f-d7b7c3bb3622"vim.Folder"
        }
    ],
    "meta": {
 },       "count": 3,
        "namepages": "1605T-boring_goodall" {
            "first_url": "https://vss-api.eis.utoronto.ca/v2/folder?per_page=100&page=1&expand=True",
 }         ]     },
    "meta": {
        "count": 5,"last_url": "https://vss-api.eis.utoronto.ca/v2/folder?per_page=100&page=1&expand=True",
            "timenext_url": "0.42114s"null,
            "userpage": "jm"
    }
}

Create

To create a new folder you just need to submit a request to /v2/folder/<moref> and provide the name of the new folder as a parameter. So, the folder <moref> will be parent of the new folder. For this example we will create a subfolder in APIDemo > APISubFolder, so request will be crafted as follows:

Code Block

http -a $TK POST https://vss-api.eis.utoronto.ca:8001/v2/folder/group-v6736 name=APISubFolder
curl -H "Content-Type: application/json" -u $TK -X POST https://vss-api.eis.utoronto.ca:8001/v2/folder/group-v6736 -d '{"name": "APISubFolder"}'

Code Block

title	Respoonse Headers

HTTP/1.1 202 ACCEPTED
Allow: POST, HEAD, OPTIONS, GET
Connection: keep-alive
Content-Length: 400
Content-Type: application/json
Date: Wed, 11 May 2016 17:19:15 GMT
Location: https://vss-api.eis.utoronto.ca/v2/request/task/fff43ba4-40c1-40df-bf5b-02f5424e091a
Server: nginx
X-RateLimit-Limit: 3000
X-RateLimit-Remaining: 2997
X-RateLimit-Reset: 1462989600

Code Block

language	py
title	Response Body
collapse	true

{
    "data": {
        "_links": {
            "request":1,
            "pages": 1,
            "per_page": 100,
            "prev_url": null,
            "total": 3
        },
        "time": "0.11766s",
        "user": "jm"
    }
}

Paging

All requests to the /folder URL are paginated. The response body includes a 'meta.pages' key with everything to navigate through the results, for instance:

Key	Description
first_url	Contain the URLs to navigate through results.
last_url
prev_url
next_url
page	Current page
pages	Total number of pages
per_page	Results per page. Maximum 250; Default 10.
total	Total number of results

Results per page can be set by including the parameter in the URL query, so we can get the desired number of elements per page, for example:

Code Block

http GET "https://vss-api.eis.utoronto.ca/v2/folder?per_page=1" "Authorization: Bearer $TK"
curl -H "Authorization: Bearer $TK" -X GET "https://vss-api.eis.utoronto.ca:8001/v2/request/folder/2",
            "task": "https://vss-api.eis.utoronto.ca:8001/v2/request/task/fff43ba4-40c1-40df-bf5b-02f5424e091a"
        },
        "message": "VM Folder creation request has been accepted for processing",
        "name": "Accepted",
        "state": "Submitted",
        "status": 202
    },
    "meta": {
        "time": "0.07877s",
        "user": "jm"
    }
}

Listing folder

Listing folders with the API word in them, would show the folder has been successfully created:

Code Block

language	py
title	Response Body
collapse	true

{
    "_links": {
        "api":folder?per_page=1"

Filtering

Folders can be filtered by adding the filter argument to the query string in the following format:

Code Block
filter=<field_name>,<operator>,<value>

Operators can be:

Operator	Description
eq	Equals
ne	Not equal
lt	Lower than
le	Lower equal
gt	Greater than
ge	Greater equal
like	Matching pattern
in	Match value in many items separated by commas

A resource can be filtered by as many attributes the request has, for instance /folder can be filtered by moref, path, created_on, name, etc. Thus, the following example will filter only by name=Prod

Code Block
http GET "https://vss-api.eis.utoronto.ca/v2/folder?per_page=10&expand=1&filter=name,like,%Prod%" "Authorization: Bearer $TK"

Sorting

The resource provides also attribute sorting by adding the sort parameter in the URL query string in the following format:

Code Block
sort=<field_name>,<asc\|desc>

The following example shows how to filter by label:

Code Block

http GET "https://vss-api.eis.utoronto.ca/v2/folder?per_page=10&expand=1&filter=name,like,%Prod%&sort=label,desc" "Authorization: Bearer $TK"

curl -X GET -H "Authorization: Bearer $TK" "https://vss-api.eis.utoronto.ca:8001/v2/",
        "self": "https://vss-api.eis.utoronto.ca:8001/v2/folder"
    },
    "data": [
        {
            "_links": {
                "self": "network?per_page=10&expand=1&filter=name,like,%VL%&sort=label,desc"

Create

To create a new folder you just need to submit a request to /v2/folder/<moref> and provide the name of the new folder as a parameter. So, the folder <moref> will be parent of the new folder. For this example we will create a subfolder in APIDemo > APISubFolder, so request will be crafted as follows:

Code Block

http -a $TK POST https://vss-api.eis.utoronto.ca:8001/v2/folder/group-v6899v6736 "Authorization: Bearer $TK" name=APISubFolder
         },
            "full_path": "VSS > Sandbox > jm > APIDemo > APISubFolder",
            "moref": "group-v6899",
            "name": "APISubFolder",
            "parent": "APIDemo"
        },
       curl -H "Content-Type: application/json" -H "Authorization: Bearer $TK" -X POST https://vss-api.eis.utoronto.ca/v2/folder/group-v6736 -d '{"name": "APISubFolder"}'

Code Block

title	Respoonse Headers

HTTP/1.1 202 ACCEPTED
Allow: POST, HEAD, OPTIONS, GET
Connection: keep-alive
Content-Length: 400
Content-Type: application/json
Date: Wed, 11 May 2016 17:19:15 GMT
Location: https://vss-api.eis.utoronto.ca/v2/request/task/fff43ba4-40c1-40df-bf5b-02f5424e091a
Server: nginx
X-RateLimit-Limit: 3000
X-RateLimit-Remaining: 2997
X-RateLimit-Reset: 1462989600

Code Block

language	py
title	Response Body
collapse	true

{
    "data": {
            "_links": {
 
              "selfrequest": "https://vss-api.eis.utoronto.ca:8001/v2/request/folder/group-v67362",
            },
            "full_path": "VSS > Sandbox > jm > APIDemo",
   "task": "https://vss-api.eis.utoronto.ca/v2/request/task/fff43ba4-40c1-40df-bf5b-02f5424e091a"
        },
        "morefmessage": "group-v6736",
   VM Folder creation request has been accepted for processing",
        "name": "APIDemoAccepted",	
 
          "parentstate": "jmSubmitted",
        }
    ],
    "meta": {"status": 202
    },
    "countmeta": 2,{
        "time": "0.55448s07877s",
        "user": "jm"
    }
}

Update

Renaming or moving folders between your folder tree is possible by making a PUT request to the URI folder in question sending both the attribute and value you wish to update. Currently, we support name and parent as supported attributes.

Attribute	Description
name	folder new name
parent	managed object reference of new parent folder

The following request illustrates how to update a folder's name (group-v6736) to NewAPIFolder:

Code Block

http -a $TK PUT https://vss-api.eis.utoronto.ca:8001/v2/folder/group-v6736 "Authorization: Bearer $TK" attribute="name" value="NewAPIFolder" 
curl -H "Content-Type: application/json" -uH "Authorization: Bearer $TK" -X PUT https://vss-api.eis.utoronto.ca:8001/v2/folder/group-v6736 -d '{"attribute": "name", "value": "NewAPIFolder"}'

HTTP response would look something like:

Code Block

title	Respoonse Headers

HTTP/1.1 202 ACCEPTED
Allow: HEAD, GET, PUT, POST, OPTIONS
Connection: keep-alive
Content-Length: 437
Content-Type: application/json
Date: Mon, 27 Jun 2016 14:38:32 GMT
Location: https://vss-api.eis.utoronto.ca/v2/request/task/d7eec47d-fd14-4958-a5ff-bfb93a191a01
Server: nginx
X-RateLimit-Limit: 3000
X-RateLimit-Remaining: 2996
X-RateLimit-Reset: 1467039600

Code Block

language	py
title	Response Body
collapse	true

{
    "data": {
        "_links": {
            "request": "https://vss-api.eis.utoronto.ca:8001/v2/request/folder/3",
            "task": "https://vss-api.eis.utoronto.ca:8001/v2/request/task/d7eec47d-fd14-4958-a5ff-bfb93a191a01"
        },
        "message": "VM Folder change request has been accepted for processing",
        "name": "Accepted",
        "state": "Submitted",
        "status": 202
    },
    "meta": {
        "time": "0.39327s",
        "user": "jm"
    }
}

Tip

If you wish to update any parent folder, just select the new parent moref and include it in the PUT request attribute's value, i.e.

Code Block

http -a $TK PUT https://vss-api.eis.utoronto.ca:8001/v2/folder/group-v6736 "Authorization: Bearer $TK" attribute="parent" value="group-v1234"
curl -H "Content-Type: application/json" -uH "Authorization: Bearer $TK" -X PUT https://vss-api.eis.utoronto.ca:8001/v2/folder/group-v6736 -d '{"attribute": "parent", "value": "group-v1234""}'

Where group-v1234 would be new parent of group-v6736

Versions Compared

Old Version 11

New Version Current

Key

Introduction

List

List

Filters

List specific folder info

Create

Paging

Listing folder

Filtering

Sorting

Create

Update

Page Comparison

Versions Compared

Old Version 11

New Version Current

Key

Introduction

List

List

Filters

List specific folder info

Create

Paging

Listing folder

Filtering

Sorting

Create

Update