REST API

更新 2025-04-29

ベースURI

https://REGION.onetimesecret.com/api

ここで REGION は CA、EU、NZ、UK、または US のいずれかです。

データロカリティとリージョンの選択

リージョンを選択してください（例: EU eu.onetimesecret.com、UK uk.onetimesecret.com、または US us.onetimesecret.com）。すべてのオプションはリージョンをご覧ください。
データ主権、レイテンシー、コンプライアンス要件などの要因を考慮する。
NOTE: デフォルトの onetimesecret.com は引き続き運用可能で、アクティブなデータセンターにルーティングされますが、この機能は将来廃止される可能性があるため、特定のロカリティを使用することをお勧めします。

APIは2つの利用モードをサポートしています：

https://USERNAME:APITOKEN@REGION.onetimesecret.com/api

https://REGION.onetimesecret.com/api

Onetime Secretは複数のデータセンターをサポートしています。地域間のデータ共有ゼロポリシーに従い、データの完全な分離を保証します。お客様のニーズに合ったデータセンターをお選びください：

希望するドメインに直接移動することで、特定のデータロカリティを選択することができる。
あなたのシークレットの場所は、生成されたリンク（例：us.onetimesecret.com/secret/abcd1234）から常に明らかです。
NOTE: 現在、onetimesecret.com/api経由でのアクセスはまだ可能ですが、この機能は将来廃止される可能性があるため、特定のロケールを使用することをお勧めします。

Onetime Secretは、Identity Plusプランにより、特定のネットワークやブランディングを必要とする組織向けのカスタムドメイン設定をサポートしています。

プレミアム機能 カスタムドメインはIdentity Plusプランでご利用いただけます。使いやすい設定オプションで数分でセットアップが完了します。詳細はこちら。

カスタム・ドメインを使用する場合、すべての API エンドポイントは同じ構造に従います：

https://secrets.example.com/api

GET https://REGION.onetimesecret.com/api/v1/status システムの現在の状態。

パラメーター: なし

$ curl -u 'USERNAME:APITOKEN' https://eu.onetimesecret.com/api/v1/status
{"status":"nominal"}

$ curl -u 'USERNAME:APITOKEN' https://uk.onetimesecret.com/api/v1/status
{"status":"nominal"}

$ curl -u 'USERNAME:APITOKEN' https://us.onetimesecret.com/api/v1/status
{"status":"nominal"}