Update Folder
This documentation is for Kyvos 2026.6.x. To view documentation for other Kyvos versions, click here. |
|---|
Overview
This API updates an existing Folder. It supports the following entities: Semantic Model, Dataset, Dataset Relationship, Workbook, and AI Space.
Method: PUT
Request URL: {kyvos-url}/rest/v2/folders/{foldername-or-id}
Authorization
API Key: sessionid
This method authenticates requests using a session ID which acts like an API key.
BasicAuth: HTTP Authorization Scheme
This method authenticates requests using a username and password sent in the HTTP Authorization header.
Headers
Header Name | Type | Description | Possible Values |
|---|---|---|---|
Content-Type (Required) | String | Specifies the media type of the request body. |
|
sessionid | String | The session ID is the token received from the login API. Note: Session ID is required for token-based authentication. | – |
Path Parameters
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
foldername-or-id (Required) | String | Name or ID of the Folder that needs to be updated. | – |
Query Parameters
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
by | String | Specifies whether the foldername-or-id parameter should be interpreted as a Folder name or Folder ID. If by=name, provide the Folder name in the foldername-or-id parameter. If by=id, provide the Folder ID in the foldername-or-id parameter. The default value is name. | – |
Request Body
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
updatedName (Required) | String | New name to assign to the Folder. | – |
folderType (Required) | String | Type of entity for which the Folder is to be updated. |
|
Responses
200 Success
{
"code": 0,
"message": "Successfully replaced folder: Account Folder"
}Status Code | Description |
|---|---|
401 | Authorization information is missing or invalid. |
404 | No matching record found. |
412 | Precondition failed. Parameter missing. |
500 | Internal Server Error |