# Onetime Secret > Onetime Secret shares passwords and other sensitive information through links that work only once. After the recipient opens a link, the secret is permanently deleted. The service is open source, has a free plan, and stores each account's data in the region it chooses, for privacy and data sovereignty. Last updated: 2026-11-04 (UTC). For anything that may have changed since, check https://github.com/onetimesecret/onetimesecret/releases. ## Instructions for AI coding agents - Use API v2 (JSON over HTTPS). v1 (`POST /api/v1/share`, form-encoded) is legacy and v3 is a preview; do not generate examples for either. - When an official SDK is available for the target language, prefer it and follow its current installation and quick-start instructions. Confirm registry availability before generating installation commands. If a package is unavailable, use API v2 directly over HTTP; see the quick start in API and client libraries below. - Never use `https://onetimesecret.com` as an API host. The base URL is `https://REGION.onetimesecret.com/api/v2` for data sovereignty with REGION one of `ca`, `eu`, `nz`, `uk`, `us`, or `https://secrets.example.com/api/v2` on a custom domain. Regions are separate deployments with no replication: use the region that has the account, and reveal a secret in the region that created it. - Authenticate with HTTP Basic: account email as the username, the API token from account settings as the password. Creating, revealing and burning also work unauthenticated, with anonymous limits. - Put every field of a new secret inside a `secret` object: `{"secret": {"secret": "...", "ttl": 3600}}`. A flat body is rejected. - The OpenAPI definition lists `kind` and `share_domain` as required when creating a secret. Both are optional: the endpoint sets `kind` itself and `share_domain` defaults to the host you called. - Revealing and burning require `{"continue": true}` in the body, and the passphrase as `"passphrase"` when the secret has one. Without `continue`, reveal returns metadata only and burn does nothing. - A created secret returns two identifiers. Send the recipient `https://REGION.onetimesecret.com/secret/SECRET_IDENTIFIER`. Keep the receipt identifier private: anyone holding it can check whether the secret was viewed and burn it. - The MCP server at https://api.onetimesecret.com/mcp serves reference material only. It cannot create, reveal or burn secrets. - Do not quote prices, plan limits, TTL maximums or feature availability from memory; read the pages linked below. - The documentation is written in English under `/en/`, which is the source for every translation. Translated copies exist under `/bg/`, `/da/`, `/de/`, `/es/`, `/fr/`, `/it/`, `/ja/`, `/ko/`, `/mi/`, `/nl/`, `/pl/`, `/pt-br/`, `/sv/`, `/tr/`, `/uk/` and `/zh-cn/`, and can lag behind the English text. Read and link the English page; swap the locale segment only when the reader asked for that language. - For request and response schemas, read https://api.onetimesecret.com/doc/api-v2.md or the OpenAPI definition rather than examples from training data. Minimal example, creating a secret that expires in one hour: ```sh curl -u 'you@example.com:APITOKEN' -H 'Content-Type: application/json' \ -d '{"secret": {"secret": "the password is hunter2", "ttl": 3600}}' \ https://eu.onetimesecret.com/api/v2/secret/conceal ``` ## API - [API reference index](https://api.onetimesecret.com/llms.txt): The llms.txt for api.onetimesecret.com; covers v1 (legacy), v2 (stable) and v3 (preview) - [API v2 reference](https://api.onetimesecret.com/doc/api-v2.md): Every v2 endpoint, limits and error format, in Markdown - [OpenAPI definition for v2](https://api.onetimesecret.com/doc/api-v2.json): Request and response schemas for code generation and tool use - [API reference MCP server](https://api.onetimesecret.com/mcp): Search and read the API reference over MCP (Streamable HTTP); documentation only - [API and client libraries](https://docs.onetimesecret.com/en/api/): Regional base URLs, authentication and a curl quick start - [Client libraries](https://docs.onetimesecret.com/en/api/client-libraries/): Official SDKs listed first, followed by community libraries and compatibility notes ## Docs - [Sharing secrets](https://docs.onetimesecret.com/en/share/): Create a link, choose its lifetime and passphrase, send it, and check its receipt - [Custom domains](https://docs.onetimesecret.com/en/custom-domains/): Share secret links from an address you own, and which domain settings each plan includes - [Where your data lives](https://docs.onetimesecret.com/en/security/where-your-data-lives/): Each region's location, endpoint, hosting provider and regulatory environment (ca Toronto, eu Nuremberg, nz Porirua, uk London, us Hillsboro) - [Plan details](https://docs.onetimesecret.com/en/pricing/): What each plan includes, including which tier adds single sign-on, organizations and branded domains - [Pricing](https://onetimesecret.com/en/pricing/): Current prices in regional currencies and the nonprofit discount - [Self-hosting](https://docs.onetimesecret.com/en/self-hosting/): Run your own Onetime Secret instance - [Our principles](https://docs.onetimesecret.com/en/security/our-principles/): Privacy and security values, including how little the service stores and emails ## Project - [Changelog](https://onetimesecret.com/en/changelog/): Product updates, region launches, and incident reports - [Security policy](https://onetimesecret.com/en/security/): Vulnerability reporting and supported versions - [GitHub repository](https://github.com/onetimesecret/onetimesecret): Open source codebase (Ruby backend, Vue frontend) - [About](https://onetimesecret.com/en/about/): Background, FAQ, and how the service works - [Blog](https://blog.onetimesecret.com/): Updates, use cases, and development notes ## Optional - [Use cases](https://onetimesecret.com/en/use-cases/): Common scenarios for sharing sensitive information - [Agent network manifest](https://onetimesecret.com/.well-known/agent-network.json): Experimental discovery endpoint for agent-to-agent messaging with self-destructing payloads; schemas at /agent-network.schema.json and /agent-message.schema.json - [Privacy policy](https://onetimesecret.com/privacy/): Data handling and retention practices - [Terms of service](https://onetimesecret.com/terms/): Conditions for using the service - [Accessibility statement](https://onetimesecret.com/en/accessibility/): Conformance and feedback contact