Share Meta

GET

/v1/share/{token}

curl --request GET \
  --url https://api.cloud.agentums.ru/v1/share/example \
  --header 'x-share-password: '

• Прод

Метаданные ссылки для публичной страницы. Без верного пароля контент не раскрываем.

Parameters

Path Parameters

token

required

Token

string

Header Parameters

x-share-password

X-Share-Password

string

""

Responses

200

Successful Response

Media typeapplication/json

ShareMeta

Метаданные ссылки для публичной страницы. При защите паролём без верного пароля контент (список/имя) не раскрывается — только needs_password.

object

can_upload

Can Upload

boolean

count

Count

integer

0

kind

required

Kind

string

Allowed values: folder file

name

Name

string

""

needs_password

Needs Password

boolean

object

Any of:

SharePublicObject

SharePublicObject

Лёгкое представление файла для публичной страницы (без внутренних подсказок/полей).

object

created_at

required

Created At

string format: date-time

display_name

Display Name

string

""

doc_type

Doc Type

string

default: other

filename

Filename

string

""

id

required

Id

string format: uuid

kind

Kind

string

""

mime

Mime

string

""

size

Size

integer

0

status

Status

string

""

text_view

Text View

boolean

null

null

object_id

Any of:

string

string format: uuid

null

null

role

Role

string

default: viewer

Allowed values: viewer contributor

Example

{
  "can_upload": false,
  "count": 0,
  "kind": "folder",
  "name": "",
  "needs_password": false,
  "object": {
    "display_name": "",
    "doc_type": "other",
    "filename": "",
    "kind": "",
    "mime": "",
    "size": 0,
    "status": "",
    "text_view": false
  },
  "role": "viewer"
}

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

Example^generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}