cPanel API 2 Functions - Fileman::savefile

Warning:

The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.

Description

This function saves a string to a file.

Warning:

We deprecated this function. We strongly recommend that you use the following UAPI function instead of this function:

Fileman::save_file_content — This function saves a file in a directory and encodes it in a character set.

Important:

When you disable the File Storage role, the system disables this function.

Examples

WHM API (JSON)

https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Fileman&cpanel_jsonapi_func=savefile&path=home%2Fexample&filename=new_file&content=This%20is%20a%20saved%20string.

Note:

For more information, read our Calls from the WHM API documentation.

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// Create a directory.
$mkdir = $cpanel->api2(
    'Fileman', 'savefile',
        array(
        "path"                =>       "/home/example",
        "filename"            =>       "new_file",
        "content"         =>       "This is a saved string."
        )
);

Note:

For more information, read our Guide to the LiveAPI System.

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

# Create a file.
my $savefile = $cpliveapi->api2(
    'Fileman', 'savefile',
      {
        "path"                =>       "/home/example",
        "filename"            =>       "new_file",
        "content"         =>       "This is a saved string."
      }
 );

Note:

For more information, read our Guide to the LiveAPI System.

cPanel Tag System (deprecated)

Warnings:

cPanel tags are deprecated . We strongly recommend that you only use the LiveAPI system to call the cPanel APIs. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI .
cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
For more information, read our Deprecated cPanel Tag Usage documentation.

Command Line

cpapi2 --user=username Fileman savefile path=%2Fhome%2Fexample filename=new_file content="This is a saved string."

Notes:

You must URI-encode values.
username represents your account-level username.
You must include the --user=username option.
For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command.
If you run CloudLinux™, you must use the full path of the cpapi2 command:
```
/usr/local/cpanel/bin/cpapi2
```

Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "savefile",
    "data": [
      {
        "path": "/home/example/new_file",
        "charset": "utf-8"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Fileman"
  }
}

Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

Parameter	Type	Description	Possible values	Example
`path`	string	Required The new file's path.	A valid absolute file path.	`/home/user`
`filename`	string	Required The new file's name.	A valid file name.	`new_file.txt`
`content`	string	Required The new file's contents.	A valid string.	`This is saved content.`
`charset`	string	The new file's character set. This parameter defaults to `utf-8`. We strongly recommend that you do not use this parameter.	A valid character set.	`utf-32`

Returns

Return	Type	Description	Possible values	Example
`charset`	string	The file's character set.	The `charset` input parameter's value.	`utf-8`
`path`	string	The file's path.	A valid absolute file path.	`/home/example/new_file`
`reason`	string	A reason for failure This function only returns a `reason` value if an error occurred.	A string that describes the error.	`This is an error message.`
`result`	Boolean	Whether the function succeeded.	`1` — The function succeeded. `0` — The function failed.	`1`