Create Source

Creates a new source in the environment identified with the ID {envId}.

URI: POST /resource/create/source/{envId}

Parameters

Parameters in bold are mandatory

Location

Name

Description

Type

path

envId

The ID of the environment where the new source will be created.

See Get Resource ID for further details on how to retrieve IDs.

str

querystring

srctype

The type of the source to be created. Possible sources are:

  • 'filesystem'

  • 'database'

  • 'macro'

  • 'vault'.

str

body

connectionInfo

The parameters to connect to the source, which can be:

  • url”: the login url.

  • username”: the login username.

  • password” the login password.

  • fstype”: the filesystem type, which can be ‘SharePoint’, ‘HDFS’, ‘Ftp Serve’, ‘Http Server’, ‘Aws S3’, ‘ShareDrive File Sysyem’.

  • type”: the vault type, which can be: ‘vault’.

  • user”: the login user.

  • tenant”: the login tenant.

dict

querystring

label

The name of the new source.

str

body

permissionList

The permissions assigned to the new source. The parameters to specify are:

  • name”: the name of the user or of the group. If "type" is set to "other" this has to be null.

  • type”: the type of entity to which the permissions are assigned. It can be:

    • "user"

    • group"

    • "other"

  • view”: the view permissions of the specified entity. They can be:

    • "allow"

    • "deny"

    • "unspecified" (default value).

  • modify”: the modify permissions of the specified entity. They can be:

    • "allow"

    • "deny"

    • "unspecified" (default value)

  • create”: the create permissions of the specified entity. They can be:

    • "allow"

    • "deny"

    • "unspecified" (default value)

  • execute”: the execute permissions of the specified entity. They can be:

    • "allow"

    • "deny"

    • "unspecified" (default value)

  • delete”: the delete permissions of the specified entity. They can be:

    • allow"

    • "deny"

    • "unspecified" (default value)

  • setpermissions”: the setpermissions permissions of the specified entity. They can be:

    • allow"

    • "deny"

    • "unspecified" (default value)

  • sharepermissions”: the share permissions of the specified entity. They can be:

    • allow"

    • "deny"

    • "unspecified" (default value)

list

To see details on possible response codes, go to API Responses.