vaults/{vaultId}/folders
Creates a single folder as an immediate child of an existing parent folder, identified by parentFolderId and name in the request body. Only one folder is created per request; multi-segment path creation is not supported. Idempotency-Key is not supported in v1.
Resource Information
| Method and URI | POST /AutodeskDM/Services/api/vault/v2/vaults/{vaultId}/folders |
| Authentication Context | User context required |
| Required OAuth Scopes | No scopes required |
| Data Format | JSON |
Request
Headers
| Authorization* string | Must be Bearer <token>, where <token> is a three-legged access token obtained via an Authorization Code flow or a Secure Service Account (SSA) flow.
The SSA flow is designed for headless server-to-server operations. While it functions like a two-legged flow (no user interaction), it is classified as three-legged because it preserves user context. |
| Content-Type* string | Must be application/json |
Request
URI Parameters
| vaultId string | The unique identifier of a Knowledge Vault. |
Request
Body Structure
| parentFolderId* string | The Vault folder id of the parent folder. Also accepts the reserved alias root (case-insensitive) for the vault root folder. |
| name* string | The name of the folder to create. |
| isLibrary boolean | Indicates whether the new folder is a library folder. Defaults to false when omitted. This value must match the parent folder’s library status or the request fails, except for a folder created directly under the vault root, which may opt into isLibrary: true regardless of the root’s own library status.
|
| categoryId string | The id of the category to assign to the new folder. Defaults to the server’s default folder category when omitted. |
Response
HTTP Status Code Summary
| 201 Created | The folder was successfully created. |
| 400 Bad Request | The server was unable to process the request. The syntax of the request is malformed or the request is missing a required header. Do not repeat the request without fixing the issue. The response body may indicate what is wrong with the request. |
| 401 Unauthorized | The supplied authorization header was not valid or the supplied token scope was not acceptable. Verify authentication and try again. |
| 403 Forbidden | The request was successfully validated but lacking the required permissions. Verify your credentials and permissions before you send this request again. |
| 404 Not Found | The requested resource was not found. |
| 409 Conflict | A folder with the same name already exists under the specified parent folder. |
Response
Header (201)
| Location string | The URL of the created folder. |
Response
Body Structure (201)
| id string | The unique identifier of this folder. |
| url string | The relative URL to access this object. |
| name string | The descriptive name of this folder. This is the folder name without the full path. |
| fullName string | The full Vault path for this folder (for example, $/Folder1). |
| createDate datetime: ISO 8601 | The date and time when the folder was created. |
| createUserName string | The name of the user who created this folder. |
| category string | The category assigned to this folder. |
| categoryColor number | The color of the category. |
| state string | The name of the lifecycle state for this folder. |
| stateColor number | The color of the lifecycle state. |
| subfolderCount number | The number of immediate child folders. |
| children string | The URI to retrieve child folders. |
| isLibrary boolean | Indicates whether this folder is a library folder.
|
| isReadOnly boolean | Indicates whether this folder can be modified by the logged-in user.
|
| isCloaked boolean | Indicates whether this folder is cloaked. A cloaked object is one that the caller does not have permissions to view.
|
| properties array: object | An array of property values for this folder. |
| propertyDefinitionId string | The unique identifier of the property definition that this value belongs to. |
| definition object | Contains server-side metadata for a Vault property definition, including datatype and naming. |
| id string | The unique identifier of the property definition. |
| url string | The relative URL to access this object. |
| displayName string | The display name of this property definition. |
| systemName string | The system name of this property definition. |
| dataType enum:string | The underlying data type stored for values of this property.
Possible values: String, Numeric, Bool, DateTime, Image |
| active boolean | Indicates whether this property definition is active.
|
| isSystem boolean | Indicates whether this property definition is a built-in system property.
|
| initialValue string | The default value applied to entities that do not have an existing value for this property definition. |
| value string | The property value associated with the entity for the referenced property definition. |
Example
This example illustrates how to create a folder under an existing parent folder.
Note: {VaultServerAddress} is used as a placeholder in the example(s) and could represent one of the following:
- Vault Server IP address or hostname. Ex: http://10.41.110.49.
- Vault Gateway URL if gateway is configured. Ex: https://test.vg.autodesk.com.
Request
curl -v '{VaultServerAddress}/AutodeskDM/Services/api/vault/v2/vaults/9/folders' \
-X 'POST' \
-H 'Content-Type: application/json'\
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a...'\
-d '{
"parentFolderId": "1",
"name": "2027-Projects"
}'
On success, Vault returns 201 Created. The response includes a Location header with the URL of the new folder.
Response
{
"name": "2027-Projects",
"id": "221",
"fullName": "$/2027-Projects",
"category": "Folder",
"subfolderCount": 0,
"isLibrary": false,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/9/folders/221"
}