JSON API » files » files/update

Updates an existing file.

Input parameters

Requires authentication and the files role privilege.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
id	Integer	ID of file to update.	Yes
data	Base64	Base64 encoded contents of file.	No	Current contents.
description	String	Description.	No	Current value.
filename	String	An optional file name.	No	Current value.
mimetype	String	An optional mimetype.	No	Current value.
name	String	Name.	No	Current value.
public	Integer	1 to make publicly available, 0 not to.	No	Current value.
validation	Integer	1 to validate input then return, 0 for full action.	No	0

Responses

Code	Description
201	Input passed validation. Only returned if validation=1.
204	Success.
400	Invalid input parameters specified. Check the key and message fields for more details.
401	The authentication details provided are invalid.
402	Your role does not allow this.
404	The file does not exist, or you do not have permission to update it.

Data returned

No data is returned.

Example: Changing the name

http://enswitch.example.com/api/json/files/update/?auth_username=user;auth_password=password;id=123;name=example1.css

{ "responses":[ { "code":"204", "key":"", "message":"OK" } ] }

Change history

Version	Changes
4.0	Function added.