> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hybridbox.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Hybridbox Public API

> Hybridbox Public API を使用して、アカウント、ドメイン、メールボックス、DNS レコード、転送ルール、マスターパスワード、タグ、ワークスペース、専用 IP を管理できます。

# Hybridbox Public API

## 認証

REST API は OAuth 2.0 bearer アクセストークンを使用します。

ブラウザーまたは Web アプリ連携でトークンを取得する手順:

1. Hybridbox Web アプリの公開クライアントで、標準の OAuth 認可コードフローを開始します。
2. ユーザーを Hybridbox の認可エンドポイントへ送信し、通常の OpenID スコープを要求します。
3. ユーザーのサインイン後、返された認可コードを Hybridbox のトークンエンドポイントでトークンに交換します。公開ブラウザークライアントでは PKCE を使用し、サーバーサイド Web アプリではバックエンドでコード交換を行ってください。
4. トークンレスポンスの `access_token` を読み取ります。

認証が必要な REST API リクエストでアクセストークンを送信します。

```http theme={null}
Authorization: Bearer <access_token>
```

API はトークン発行者を検証し、Hybridbox Web アプリクライアントを含む許可済み公開クライアント ID を要求します。各エンドポイントページには、認証済みユーザーまたはグループに必要な追加権限が表示されます。

## OpenAPI 仕様

完全な Public API コントラクトを [openapi.json](/openapi.json) としてダウンロードできます。