Skip to content

PUT /a/share/link

Put or Create a share room

Body Parameters

Name Description Type Required
CreatePassword Set if switching from no password to password string
PasswordEnabled Whether it has Password enabled boolean
ShareLink Content of the link to create #/definitions/restShareLink
UpdateCustomHash Change the ShareLink Hash with a custom value string
UpdatePassword Set if updating an existing password string

Body Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
{
  "CreatePassword": "string",
  "PasswordEnabled": true,
  "ShareLink": {
    "AccessEnd": "string",
    "AccessStart": "string",
    "CurrentDownloads": "string",
    "Description": "string",
    "Label": "string",
    "LinkHash": "string",
    "LinkUrl": "string",
    "MaxDownloads": "string",
    "PasswordRequired": true,
    "Permissions": [
      "string"
    ],
    "Policies": [
      {
        "Action": "string",
        "Effect": "string",
        "JsonConditions": "string",
        "Resource": "string",
        "Subject": "string",
        "id": "string"
      }
    ],
    "PoliciesContextEditable": true,
    "RestrictToTargetUsers": true,
    "RootNodes": [
      {
        "Path": "string"
      }
    ],
    "TargetUsers": {},
    "UserLogin": "string",
    "UserUuid": "string",
    "Uuid": "string",
    "ViewTemplateName": "string"
  },
  "UpdateCustomHash": "string",
  "UpdatePassword": "string"
}

Response Example (200)

Response Type /definitions/restShareLink

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
{
  "AccessEnd": "string",
  "AccessStart": "string",
  "CurrentDownloads": "string",
  "Description": "string",
  "Label": "string",
  "LinkHash": "string",
  "LinkUrl": "string",
  "MaxDownloads": "string",
  "PasswordRequired": true,
  "Permissions": [
    "string"
  ],
  "Policies": [
    {
      "Action": "string",
      "Effect": "string",
      "JsonConditions": "string",
      "Resource": "string",
      "Subject": "string",
      "id": "string"
    }
  ],
  "PoliciesContextEditable": true,
  "RestrictToTargetUsers": true,
  "RootNodes": [
    {
      "AppearsIn": [
        {
          "Path": "string",
          "WsLabel": "string",
          "WsScope": "string",
          "WsSlug": "string",
          "WsUuid": "string"
        }
      ],
      "Commits": [
        {
          "Data": "string",
          "Description": "string",
          "Event": {
            "Metadata": {},
            "Optimistic": true,
            "Silent": true,
            "Source": "[Recursive structure]",
            "Target": "[Recursive structure]",
            "Type": "string"
          },
          "Location": "[Recursive structure]",
          "MTime": "string",
          "OwnerUuid": "string",
          "Size": "string",
          "Uuid": "string"
        }
      ],
      "Etag": "string",
      "MTime": "string",
      "MetaStore": {},
      "Mode": 10,
      "Path": "string",
      "Size": "string",
      "Type": "string",
      "Uuid": "string"
    }
  ],
  "TargetUsers": {},
  "UserLogin": "string",
  "UserUuid": "string",
  "Uuid": "string",
  "ViewTemplateName": "string"
}

Auto generated by Pydio Cells Enterprise Distribution v4.4.13 on 7-May-2025