---
title: "Unlock a password-protected share"
method: POST
path: "/api/share/{token}/auth"
tags: ["shares"]
---

# Unlock a password-protected share

`POST /api/share/{token}/auth`

## Request

- Base URL: `https://telawiki.com`
- URL: `https://telawiki.com/api/share/{token}/auth`
- Auth: none required

Sets a share-scoped cookie that the other `/api/share/{token}/*` reads require. Rate-limited to 5 attempts a minute per token and client IP.

## Request body

- object
  - `password` string, required

## Response `200`

Unlocked. Sets `tela_share_<token>`, scoped to this share's path.

- object
  - `ok` true, required

## Other responses

- `400`: `bad_request` — unparseable body, or this share has no password.
- `401`: `password_required` — wrong password.
- `404`: `not_found`.
- `429`: `rate_limited` — retry after the interval in the `Retry-After` header.
- `500`: `internal` — server error.

---

[API](https://skmtc.dev/telawiki/apis/tela-rest-api.md) · [All operations](https://skmtc.dev/telawiki/apis/tela-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/telawiki/apis/tela-rest-api/revisions/f316f31f6fcb?raw)
