- URL:
- https://<root>/system/directories/<directoryName>/edit
- Methods:
POST- Version Introduced:
- 10.2.1
Access requirements
Required privileges
The Portal Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Portal Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.
Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generate operation in the Portal Directory API. For security reasons, all POST requests made to the Portal Administrator API must include a token in the request body.
Description
The edit operation changes the physical path and description properties of the directory. This is useful when changing the location of a directory from a local path to a network share. However, the API does not copy your content and data from the old path to the new path. This has to be done independently by the system administrator.
Request parameters
| Parameter | Details |
|---|---|
| The new path for the directory. Example |
| The new description for the directory. Example |
| The response format. The default is Values: |
Example usage
The following is a sample POST request demonstrating the edit operation:
POST /<context>/portaladmin/system/directories/testDirectory/edit HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
physicalPath={
"type": "fileStore",
"provider": "FileSystem",
"connectionString": "//server/share/content",
"isConnectionStringEncrypted": false
}&description=The content directory.&f=pjsonJSON Response example
{
"status": "success",
"recheckAfterSeconds": 10
}