POST api/Users/{id}

Request Information

URI Parameters

Name	Description	Type	Additional information
id		integer	Required

Body Parameters

User

Name	Type	Additional information
UserName	string	None.
Password	string	None.
Salt	string	None.
HomeDir	string	None.
GroupName	string	None.
IpLimit	integer	None.
UserLimit	integer	None.
BypassUserLimit	TriState	None.
Enabled	TriState	None.
DisallowedIPs	Collection of string	None.
AllowedIPs	Collection of string	None.
SharedFolders	Collection of SharedFolder	None.
DownloadSpeedLimit	SpeedLimit	None.
UploadSpeedLimit	SpeedLimit	None.
Comment	string	None.
ForceSsl	TriState	None.

Request Formats

application/json, text/json

Sample:

{
  "UserName": "sample string 1",
  "Password": "sample string 2",
  "Salt": "sample string 3",
  "HomeDir": "sample string 4",
  "GroupName": "sample string 5",
  "IpLimit": 6,
  "UserLimit": 7,
  "BypassUserLimit": 0,
  "Enabled": 0,
  "DisallowedIPs": [
    "sample string 1",
    "sample string 2"
  ],
  "AllowedIPs": [
    "sample string 1",
    "sample string 2"
  ],
  "SharedFolders": [
    {
      "Directory": "sample string 1",
      "Aliases": [
        "sample string 1",
        "sample string 2"
      ],
      "AccessRights": 1
    },
    {
      "Directory": "sample string 1",
      "Aliases": [
        "sample string 1",
        "sample string 2"
      ],
      "AccessRights": 1
    }
  ],
  "DownloadSpeedLimit": {
    "SpeedLimitType": 0,
    "BypassServerSpeedLimit": 0,
    "ConstantSpeedLimit": 1,
    "SpeedLimitRules": [
      {
        "SpeedLimit": 1,
        "Date": "2025-12-05T22:10:11.8770094+01:00",
        "FromTime": "00:00:00.1234567",
        "ToTime": "00:00:00.1234567",
        "Days": 1
      },
      {
        "SpeedLimit": 1,
        "Date": "2025-12-05T22:10:11.8770094+01:00",
        "FromTime": "00:00:00.1234567",
        "ToTime": "00:00:00.1234567",
        "Days": 1
      }
    ]
  },
  "UploadSpeedLimit": {
    "SpeedLimitType": 0,
    "BypassServerSpeedLimit": 0,
    "ConstantSpeedLimit": 1,
    "SpeedLimitRules": [
      {
        "SpeedLimit": 1,
        "Date": "2025-12-05T22:10:11.8770094+01:00",
        "FromTime": "00:00:00.1234567",
        "ToTime": "00:00:00.1234567",
        "Days": 1
      },
      {
        "SpeedLimit": 1,
        "Date": "2025-12-05T22:10:11.8770094+01:00",
        "FromTime": "00:00:00.1234567",
        "ToTime": "00:00:00.1234567",
        "Days": 1
      }
    ]
  },
  "Comment": "sample string 8",
  "ForceSsl": 0
}

application/xml, text/xml

Sample:

<User xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Miracle.FileZilla.Api">
  <AllowedIPs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </AllowedIPs>
  <BypassUserLimit>No</BypassUserLimit>
  <Comment>sample string 8</Comment>
  <DisallowedIPs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </DisallowedIPs>
  <DownloadSpeedLimit>
    <BypassServerSpeedLimit>No</BypassServerSpeedLimit>
    <ConstantSpeedLimit>1</ConstantSpeedLimit>
    <SpeedLimitRules>
      <SpeedLimitRule>
        <Date>2025-12-05T22:10:11.8770094+01:00</Date>
        <Days>Monday</Days>
        <FromTime>PT0.1234567S</FromTime>
        <SpeedLimit>1</SpeedLimit>
        <ToTime>PT0.1234567S</ToTime>
      </SpeedLimitRule>
      <SpeedLimitRule>
        <Date>2025-12-05T22:10:11.8770094+01:00</Date>
        <Days>Monday</Days>
        <FromTime>PT0.1234567S</FromTime>
        <SpeedLimit>1</SpeedLimit>
        <ToTime>PT0.1234567S</ToTime>
      </SpeedLimitRule>
    </SpeedLimitRules>
    <SpeedLimitType>Default</SpeedLimitType>
  </DownloadSpeedLimit>
  <Enabled>No</Enabled>
  <ForceSsl>No</ForceSsl>
  <GroupName>sample string 5</GroupName>
  <IpLimit>6</IpLimit>
  <SharedFolders>
    <SharedFolder>
      <AccessRights>DirCreate</AccessRights>
      <Aliases xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </Aliases>
      <Directory>sample string 1</Directory>
    </SharedFolder>
    <SharedFolder>
      <AccessRights>DirCreate</AccessRights>
      <Aliases xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </Aliases>
      <Directory>sample string 1</Directory>
    </SharedFolder>
  </SharedFolders>
  <UploadSpeedLimit>
    <BypassServerSpeedLimit>No</BypassServerSpeedLimit>
    <ConstantSpeedLimit>1</ConstantSpeedLimit>
    <SpeedLimitRules>
      <SpeedLimitRule>
        <Date>2025-12-05T22:10:11.8770094+01:00</Date>
        <Days>Monday</Days>
        <FromTime>PT0.1234567S</FromTime>
        <SpeedLimit>1</SpeedLimit>
        <ToTime>PT0.1234567S</ToTime>
      </SpeedLimitRule>
      <SpeedLimitRule>
        <Date>2025-12-05T22:10:11.8770094+01:00</Date>
        <Days>Monday</Days>
        <FromTime>PT0.1234567S</FromTime>
        <SpeedLimit>1</SpeedLimit>
        <ToTime>PT0.1234567S</ToTime>
      </SpeedLimitRule>
    </SpeedLimitRules>
    <SpeedLimitType>Default</SpeedLimitType>
  </UploadSpeedLimit>
  <UserLimit>7</UserLimit>
  <HomeDir>sample string 4</HomeDir>
  <Password>sample string 2</Password>
  <Salt>sample string 3</Salt>
  <UserName>sample string 1</UserName>
</User>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

boolean

Response Formats

application/json, text/json

Sample:

true

application/xml, text/xml

Sample:

<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>