Skip to content
Share2Us

Submit a password challenge for a protected share.

POST
/{opaque-id}/password
curl --request POST \
  --url https://s.share2.us/example/password \
  --header 'Content-Type: application/json' \
  --data '{ "password": "example" }'

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
opaque-id
required
string
>= 12 characters

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
password
required
string
Examplegenerated
{
  "password": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

Password accepted.

Media typeapplication/json
object
public_id
required
string
>= 12 characters
filename
required
string
size_bytes
required
integer format: int64
state
required
string
Allowed values: created uploading uploaded scanning ready expired revoked blocked deleted
password_required
boolean
download_url
string | null format: uri
expires_at
required
string format: date-time
Example
{
  "state": "created"
}

default

Section titled “default”

Standard error envelope.

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
request_id
required
string
Example
{
  "error": {
    "code": "quota_exceeded"
  }
}