POST /resources/{path:.*}

Adds a folder to the console /resources/ folder structure.

You can also use this operation to create a file and provide the content of the file in a Form parameter. However, if you want to upload an existing file, use the upload operation (POST /resources/{path:.*} with Content-Type of multipart/form-data).

Note: You can only add a new folder one level down. The new folder is only added if the parent folder already exists.

Authorization Roles/Permissions: Must be logged in. Site Admin only.

This topic includes the following sections:

HTTP Method

POST

URL

https://{hostname}/resources/{path:.*}

Sample Request

The example below shows a request to add a new subfolder, images.

Sample Request URL

http://acmepaymentscorp.com/resources/images

Sample request headers

POST /resources/images HTTP/1.1
Host: {hostname}
Accept: */*
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

folder=true

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header	Description
Accept	Any value that matches text/plain is valid; for example, */*.
Content-Type	application/x-www-form-urlencoded
Cookie	AtmoAuthToken_{fedmemberid}={cookie value, which usually starts with TokenID}—The platform cookie. This is the Akana API Platform authorization token, and must be sent with every API request that requires login. For more information and an example, see Session cookies.
X-Csrf-Token_{fedmemberID}	The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login.

Request Parameters

Parameter	Parm Type	Data Type	Required	Description
Body	Form	String	Required	The resource being uploaded.
type	Form	String	Optional	The media type for the content being added. Default: text/html.
path	Path	String	Required	The path for the content being added. Include the path from the /resources/ folder downwards. You can only add a new subfolder if the parent folder already exists. If you need to create a folder structure you'll need to create one level at a time.
folder	Form	Boolean	Optional	Indicates whether the operation is adding a folder. Default: false.

Response

If successful, this operation returns HTTP status code 200, and the folder is added.

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers

HTTP/1.1 200 OK
Expires: Wed, 23 Sep 2015 15:35:40 GMT

Sample response body

Not applicable.

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header	Description
Content-Type	text/plain

Response Body

None.

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item	Value
401	Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header. You would also get this response for any operation that requires login (almost all) if the login cookie was missing.
404	The resource could not be found. For example, you might get this if the Content-Type header is set to a wrong value.
500	An error occurred processing the call.

More information about Akana API Platform API error messages.

Related Topics