Skip to main content

Create an SFTP user for a Project

POST/projects/{projectId}/sftp-users/
v2
POST
sftp-user-create-sftp-user

Request

  • projectIdstring
    required

    ID of the Project to create an SFTPUser for.

Responses

application/json

Created

  • accessLevelstring (one of: full, read, unspecified)
    required

    The level of access for an SFTPUser.

  • activeboolean
  • authUpdatedAtstring (date-time)
    required
  • createdAtstring (date-time)
    required
  • descriptionstring
    required
  • directoriesarray of string
    • Array[
    • *string
    • ]
  • expiresAtstring (date-time)
  • hasPasswordboolean
    required
  • idstring
    required
  • projectIdstring
    required
  • publicKeysarray of object
    • Array[
    • *object

      A representation of an ssh-public-key.

      • commentstring
        required
      • keystring
        required
    • ]
  • updatedAtstring (date-time)
  • userNamestring
    required
  • Usage examples

    $ curl \
    --fail \
    --location \
    -X POST \
    -d '{"accessLevel":"read","authentication":{"password":"string"},"description":"string","directories":["string"],"expiresAt":"2024-11-08T18:07:44.387Z"}' \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    -H 'Content-Type: application/json' \
    https://api.mittwald.de/v2/projects/string/sftp-users