Skip to main content
POST
/
evault
/
v1
/
file_shares
Create FileShare
curl --request POST \
  --url https://api.example.com/evault/v1/file_shares/ \
  --header 'Content-Type: application/json' \
  --data '
{
  "file": "<string>",
  "folder": "<string>",
  "access": "public",
  "users": [
    123
  ],
  "emails": "<unknown>",
  "password": "<string>"
}
'
{
  "id": "<string>",
  "user": {
    "email": "jsmith@example.com",
    "first_name": "<string>",
    "last_name": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "username": "<string>"
  },
  "file_type": "<string>",
  "file_detail": {
    "id": "<string>",
    "file": "<string>",
    "hash": "<string>",
    "mimetype": "<string>",
    "extension": "<string>",
    "file_size": 123,
    "file_size_unit": "<string>",
    "root": true,
    "access": "<string>",
    "file_share_id": "<string>",
    "is_shared": true,
    "tags_detail": [
      {
        "id": "<string>",
        "name": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "description": "<string>"
      }
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "description": "<string>",
    "folder": "<string>",
    "is_starred": true,
    "is_archived": true,
    "is_deleted": true,
    "tags": [
      "<string>"
    ]
  },
  "folder_detail": {
    "id": "<string>",
    "access": "<string>",
    "files_count": 123,
    "folders_count": 123,
    "file_size": 123,
    "file_size_unit": "<string>",
    "extension": "<string>",
    "parent_folder": "<string>",
    "root": true,
    "tags": [
      {
        "id": "<string>",
        "name": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "description": "<string>"
      }
    ],
    "files": "<string>",
    "folders": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "description": "<string>",
    "is_starred": true,
    "is_archived": true,
    "is_deleted": true
  },
  "users_detail": [
    {
      "email": "jsmith@example.com",
      "first_name": "<string>",
      "last_name": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "username": "<string>"
    }
  ],
  "has_password": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "file": "<string>",
  "folder": "<string>",
  "access": "public",
  "users": [
    123
  ],
  "emails": "<unknown>"
}

Body

​
file
string | null
Minimum string length: 1
​
folder
string | null
Minimum string length: 1
​
access

Indicate the access type of the file sharing instance.

  • public - public
  • private - private
Available options:
public,
private
​
users
integer[]

Blucera Users linked to the file sharing instance.

​
emails
any | null

Emails of Persons/Users linked to the File Sharing instance.

​
password
string
Minimum string length: 1

Response

201 - application/json
​
id
string
required
​
user
object
required
​
file_type
string
required
​
file_detail
object
required
​
folder_detail
object
required
​
users_detail
object[]
required
​
has_password
boolean
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
file
string | null
​
folder
string | null
​
access

Indicate the access type of the file sharing instance.

  • public - public
  • private - private
Available options:
public,
private
​
users
integer[]

Blucera Users linked to the file sharing instance.

​
emails
any | null

Emails of Persons/Users linked to the File Sharing instance.