Hosting User

/hosting-user

GET

Get a list of FTP users.

JSON response

Sample

curl \
--request GET \
--user "{{api_username}}:{{api_key}}" \
"{{api_base_url}}/hosting-user" | python -m json.tool

POST

Create a new FTP user.

JSON request

hosting_account string The hosting account ID for which to create the object.
username string The local part for the final username. The account reference get’s appended
password string Min. length 5. Must only contain ASCII characters.
relative_home_directory string The name of the domain that you want linked. Must already be a domain

JSON response

object: Hosting User

Sample

curl \
--request POST \
--user "{{api_username}}:{{api_key}}" \
--data '
    {
        "account": "ac-12345",
        "username": "myuser",
        "password": "welcome123",
        "relative_home_directory": "public_html"
    }
' \
"{{api_base_url}}/hosting-user" | python -m json.tool

/hosting-user/{id}

GET

JSON response

object: Hosting User

Sample

curl \
--request GET \
--user "{{api_username}}:{{api_key}}" \
"{{api_base_url}}/hosting-user/{id}" | python -m json.tool

PUT

Update an existing FTP user.

JSON request

password string Min. length 5. Must only contain ASCII characters.
relative_home_directory string The name of the domain that you want linked. Must already be a domain

JSON response

object: Hosting User

Sample

curl \
--request PUT \
--user "{{api_username}}:{{api_key}}" \
--data '
    {
        "password": "welcome123",
        "relative_home_directory": "public_html",
    }
' \
"{{api_base_url}}/hosting-user/{id}" | python -m json.tool

DELETE

Sample

curl \
--request DELETE \
--user "{{api_username}}:{{api_key}}" \
"{{api_base_url}}/hosting-user/{id}" | python -m json.tool