PUT /resources/{path:.*}

Renames a resource in the platform's /resources/ folder structure.

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

This topic includes the following sections:

HTTP Method

PUT

Back to top

URL

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

Back to top

Sample Request

The example below shows a request to rename the specified file in the developer portal's /resources folder structure.

Request URL

http://acmepaymentscorp.com/resources/img_lead2.png

Sample request headers

PUT /resources/img_lead2.png 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

nameTo=img_lead.png

Back to top

Request Headers

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

Header Description
Content-Type application/x-www-form-urlencoded
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.

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
nameTo Form String Required The new name for the resource file.

Back to top

Response

If successful, this operation returns HTTP status code 200, and the file is renamed.

Back to top

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 10:35:48 GMT

Sample response body

None.

Back to top

Response Headers

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

None.

Back to top

Response Body

None.

Back to top

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.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics