Create SFTP user
package main
import ( "fmt" "strings" "net/http" "io")
func main() {
url := "https://api.wpengineapi.com/v1/installs/294deacc-d8b8-4005-82c4-0727ba8ddde0/sftp_users"
payload := strings.NewReader("{ \"name\": \"developer\", \"password\": \"SecurePass123!\", \"path\": \"/www/wp-content\" }")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <credentials>") req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close() body, _ := io.ReadAll(res.Body)
fmt.Println(res) fmt.Println(string(body))
}const url = 'https://api.wpengineapi.com/v1/installs/294deacc-d8b8-4005-82c4-0727ba8ddde0/sftp_users';const options = { method: 'POST', headers: {Authorization: 'Basic <credentials>', 'Content-Type': 'application/json'}, body: '{"name":"developer","password":"SecurePass123!","path":"/www/wp-content"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.wpengineapi.com/v1/installs/294deacc-d8b8-4005-82c4-0727ba8ddde0/sftp_users \ --header 'Authorization: Basic <credentials>' \ --header 'Content-Type: application/json' \ --data '{ "name": "developer", "password": "SecurePass123!", "path": "/www/wp-content" }'Creates a new SFTP user for the install. The username is automatically prefixed
with the install name (e.g., input developer becomes install-developer).
Username, Password, and Path Rules
Username: Alphanumeric characters, hyphens, and underscores only. With the install-name prefix, the final username cannot exceed 32 characters.
Password: 8–64 characters. Cannot contain “wpengine” or the install name.
Path: Cannot contain .. (directory traversal sequences).
Password Handling
The password is supplied in the request and is never returned in the response. The client must store the password securely after creation, as it cannot be retrieved later.
Limitations & Warnings
- Not available for Autoscale accounts. Returns 403 for Autoscale accounts.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”ID of install
Example
294deacc-d8b8-4005-82c4-0727ba8ddde0Request Bodyrequired
Section titled “Request Bodyrequired”object
Username to create (will be prefixed with install name)
Example
developerPassword for the user
Example
SecurePass123!(Optional) SFTP path for the user
Example
/www/wp-contentResponses
Section titled “Responses”Returns the created SftpUser object.
SFTP user credentials for an install
object
Full SFTP username (auto-prefixed with install name)
SFTP path for the user
Example
{ "name": "install-developer", "path": "/www/wp-content"}Bad Request
object
A message regarding the error that occurred on the server
(Optional) A URL where documentation regarding this specific error can be found
An array of error objects describing specific errors that arose when servicing the request
object
The name of the resource that was being processed when the error occurred
(Optional) The specific field associated with the error
(Optional) A type associated with the error. invalid_value, access_error, value_unavailable
(Optional) A machine code relating to the error that occurred with the field and resource
(Optional) A human-readable message relating to the error that occurred with the field and resource
Example
{ "message": "Invalid request.", "errors": [ { "resource": "Resource", "field": "field_name", "type": "invalid_value", "code": "invalid", "message": "The value is invalid." } ]}Authentication Error
object
A message regarding the error that occurred on the server
(Optional) A URL where documentation regarding this specific error can be found
Example
{ "message": "Bad Credentials"}Not authorized (install not found, no access, or Autoscale account)
object
A message regarding the error that occurred on the server
(Optional) A URL where documentation regarding this specific error can be found
Example
{ "message": "You don't have permission to perform that action"}Too many requests
Internal Server Error
object
A message regarding the error that occurred on the server
Example
{ "message": "An unexpected error occurred, please try again in a few minutes"}An invalid response was received from an upstream server
Service unavailable