JSON API » files » files/create

Creates a new 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
data	Base64	Base64 encoded contents of file.	Yes
name	String	Name.	Yes
customer	Integer	ID of customer to create in.	No	Customer of authentication user.
description	String	Description.	No	Empty string.
filename	String	An optional file name.	No	Empty string.
mimetype	String	An optional mimetype.	No	Empty string.
public	Integer	1 to make publicly available, 0 not to.	No	0
validation	Integer	1 to validate input then return, 0 for full action.	No	0

Responses

Code	Description
200	Success.
201	Input passed validation. Only returned if validation=1.
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.

Data returned

The ID of the created file.

Example: With required parameters (data not shown for brevity)

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

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "id":123 } }

Change history

Version	Changes
4.0	Function added.