Перейти к содержимому
Agentum Cloud для разработчиков

Create Share

POST
/v1/shares
curl --request POST \
  --url https://api.cloud.agentums.ru/v1/shares \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "expires_in_days": 1, "kind": "folder", "name": "", "password": "example", "resource_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "role": "viewer" }'

Создать ссылку на папку (kind=folder) или файл (kind=file). Токен — в ответе ОДИН раз.

Authorizations

Заголовок раздела «Authorizations»

Request Bodyrequired

Заголовок раздела «Request Bodyrequired»
Media typeapplication/json
ShareCreate
object
expires_in_days
Any of:
integer
>= 1 <= 3650
kind
required
Kind
string
Allowed values: folder file
name
Name
string
"" <= 200 characters
password
Any of:
string
>= 6 characters <= 128 characters
resource_id
required
Resource Id
string format: uuid
role
Role
string
default: viewer
Allowed values: viewer contributor

Responses

Заголовок раздела «Responses»

201

Заголовок раздела «201»

Successful Response

Media typeapplication/json
ShareLinkOut
object
access_count
Access Count
integer
0
created_at
required
Created At
string format: date-time
expires_at
Any of:
string format: date-time
has_password
Has Password
boolean
id
required
Id
string format: uuid
kind
required
Kind
string
Allowed values: folder file
prefix
Prefix
string
""
resource_id
required
Resource Id
string format: uuid
resource_name
Resource Name
string
""
revoked_at
Any of:
string format: date-time
role
Role
string
default: viewer
Allowed values: viewer contributor
token
Any of:
string
upload_count
Upload Count
integer
0
url
Url
string
""
Example
{
  "access_count": 0,
  "has_password": false,
  "kind": "folder",
  "prefix": "",
  "resource_name": "",
  "role": "viewer",
  "upload_count": 0,
  "url": ""
}

422

Заголовок раздела «422»

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}