Create a Shared Folder

API Explorer: /folders

To create a shared folder:

  1. Create the folder object with a POST to the folders endpoint (see sample code).
  2. Capture the folderId returned as id from the response.
  3. Upload files (such as scripts, data files or YAML Taurus configuration files) by using the folderId and the code explained in the Upload or Update Files to Shared Folder section.

Once created, a shared folder can be used as part of any of your tests, so make sure to save the id attribute value for later use. This folderId will be used as a parameter to identify the shared folder.

Create a Shared Folder 

curl 'https://a.blazemeter.com/api/v4/folders' \
						-X POST \
						-H 'Content-Type: application/json' \
						--user 'api_key_id:api_key_secret' \
						-d '{"name":"New_folder","workspaceId":123456}'

Create a Shared Folder Request Attributes

Attributes

  • namestring

    required

    The name of the shared folder. Name can ONLY include letters, numbers and underscores

  • workspaceIdinteger

    required

    The workspaceId to tie the shared folder to

Create a Shared FolderCreate a Shared Folder POST Body (JSON) 

{
							"name": "New_folder",
							"workspaceId": 123456
							}

Create a Shared Folder Response Attributes

To see a breakdown of the attributes, please see The Folder Object section.

Response201 Created 

{
    "api_version": 4,
    "error": null,
    "result": {
        "id": "5ef276272e71f800b53bfa95",
        "name": "New_folder",
        "deletable": true,
        "hidden": false,
        "created": 1592948263,
        "workspaceId": 123456
    },
    "request_id": "5ef27626deeb2"
}