API リファレンス
SQLly Embedded ブリッジの管理 API のすべてのエンドポイント (OpenAPI (swagger.json) ドキュメントから生成) と、sqlly.app とのリンク用エンドポイント。
埋め込みモードの SQLLY ブリッジは、この API を管理リスナーで公開します(--manage-bind、デフォルト 127.0.0.1:8445)。Web アプリはサーバー側からこの API を呼び出し、接続プロファイルの保存、接続テスト、サインイン済みユーザーへの起動トークンの発行、シート使用状況の監視、ライセンス状態の読み取りや変更を行います。
すべての /manage/... 呼び出しに必要なもの Authorization: Bearer <manage token> (ブリッジの --manage-token、16 文字以上)。本文は送受信とも JSON で、最大 8 MB(超過時は次のコードで拒否 413 too_large 上限を超えるとすぐに)。パスセグメントとクエリ文字列の値はパーセントデコードされ、無効なエスケープは 400 bad_request。エラーは常に { "error": "<code>", "message": "<sentence>" }、さらに problems 資格情報ドキュメントが無効な場合に返されます。API は CORS ヘッダーを送らないので、ループバックかプライベートネットワークでの使用にとどめ、ブラウザーから決してアクセスできないようにしてください。プロファイルにはデータベースのパスワードが含まれています。
その Linking 操作はブリッジ上にはありません。これらは sqlly.app の公開エンドポイントで、管理者アプリがキーをコピーせずにインストールをライセンスに紐付けるために使います。そのサーバーは sqlly.app.
規約
- 認証:
Authorization: Bearer <manage token>すべての/manage/…呼び出し。トークンがない、または間違っている場合は401 unauthorized./healthzそしてsqlly.appのリンクエンドポイントには不要です。 - エラー は、
{ "error": "<code>", "message": "<sentence>" }。次で分岐しますerror; 表示message。無効な資格情報ドキュメントを追加するとproblems、間違い 1 つにつき 1 つの文字列。 - ボディ はJSONで、最大8 MBです。この上限は本文の受信中に適用されます。ブリッジは次の応答を返します
413 too_large渡された時点で処理し、それ以上バッファリングしません。到着に 30 秒以上かかるボディは408 timeout。解析できないものはすべて400 bad_json、不明なルートは404 not_found. - パスセグメントとクエリ値 はパーセントデコードされるため、ユーザーIDとタイムスタンプはURLエンコードしてください(
DELETE /manage/seats/a%2Fbユーザーを解放しますa/b)。無効なエスケープや UTF-8 ではない結果は400 bad_request. - フィールド名 はAPI自身のペイロードではcamelCaseです。クレデンシャルドキュメント内では、クレデンシャル形式に従います(
sql_auth_accounts,trust_server_certificate).
エンドポイント
- GET
/healthz - GET
/manage/status - POST
/manage/license/checkin - PUT
/manage/license - DELETE
/manage/license - GET
/manage/engines - GET
/manage/profiles - GET
/manage/profiles/{id} - PUT
/manage/profiles/{id} - DELETE
/manage/profiles/{id} - POST
/manage/tokens - GET
/manage/seats - DELETE
/manage/seats/{user} - POST
/manage/test-connection - GET
/manage/queries - POST
/api/embedded/links - POST
/api/embedded/links/token - GET
/api/embedded/public-key
ヘルス
Liveness はトークン不要です。
/healthz
トークンなし
Liveness プローブ
管理リスナーが起動するとすぐに応答します。トークンは不要です。起動スクリプトやサービスのヘルスチェックから使用してください。
- 200
- 管理 API は待ち受けています。
200 応答の例
{
"ok": true
}
ライセンス
ブリッジのライセンス:状態、チェックイン、リンクとリンク解除。
/manage/status
ブリッジとライセンスのステータス
管理者画面に必要な情報はすべて揃っています。ライセンスの状態とその入手元、署名付きグラントに含まれる許容量、使用中のシート、開いているセッション、ブラウザーが使うプロキシ URL。
- 200
- 現在の状態。
- 401
unauthorized: 管理トークンがないか、誤っている。
200 応答の例
{
"version": "1.1.0",
"instanceId": "b5e1c0f2-7d3a-4c8e-9a61-0f2d4b7e9c13",
"mode": "connected",
"license": {
"state": "ok",
"source": "linked",
"licenseId": "emb_Q2x0b3VkU3FsbHkxMjM0NTY3",
"plan": "embedded-25",
"planName": "SQLly Embedded 25",
"status": "active",
"seats": 25,
"sessionsPerSeat": 4,
"instances": 1,
"domain": "portal.example.com",
"periodEnd": "2027-10-14T00:00:00+00:00",
"graceEnd": null,
"daysRemaining": 365,
"lastCheckinAt": "2026-10-14T15:00:02Z",
"staleAt": "2026-10-14T15:40:02Z",
"licenseFile": null,
"message": null,
"fromCache": false,
"features": [
"embedded",
"unlimited-connections",
"all-engines",
"test-connection"
]
},
"seatsUsed": 3,
"activeSessions": 4,
"proxyUrl": "wss://portal.example.com/sqlly/proxy",
"allowLocalhostOrigins": false,
"storeUrl": "https://sqlly.app",
"allowFileEngines": false
}
401 応答の例
{
"error": "unauthorized",
"message": "management token missing or wrong"
}
/manage/license/checkin
今すぐ sqlly.app にチェックイン
接続型ライセンスとリンク済みライセンス: 20 分ごとのループを待たずに、すぐにチェックインを実行します。オフラインライセンス: ライセンスファイルを再読み込みし、ネットワークには一切アクセスしません。いずれの場合も、返されるのは試行後の状態です。失敗した場合、状態は変更されません。
- 200
- チェックイン後のステータス。
- 401
unauthorized: 管理トークンがないか、誤っている。- 409
not_linked: ブリッジにライセンスがない場合は、チェックインするものはありません。- 422
license_file_invalid(オフライン): ファイルが見つからない、破損している、または別のキー用に署名されています。- 502
store_unreachableまたはgrant_invalid: sqlly.app に到達できなかったか、またはその応答を検証できませんでした。
401 応答の例
{
"error": "unauthorized",
"message": "management token missing or wrong"
}
409 応答の例
{
"error": "not_linked",
"message": "this bridge is not linked to a license yet"
}
/manage/license
リンクされたライセンスキーをインストール
次のフラグなしで起動されたブリッジに、キーを実行時に渡します --license-key / --license-file 実行時にキーを受け取ります (通常は、管理アプリがリンクフローを通じて sqlly.app から取得したキー)。ブリッジは最初にそれでチェックインし、保存します (<state-dir>/license-key、モード 0600)。ただし、sqlly.app が検証済みの付与で応答した場合に限ります。それ以降は接続型ブリッジとして動作し、キーは再起動後も再利用されます。失敗しても何も変わりません。新しいキーが検証されるまで、使用中のキーが引き続き動作します。リンク済みのキーを別のライセンスのキーに置き換えると、新しいキーの検証後に古いライセンスのインスタンススロットが解放されます。同じライセンスの再生成されたキーは、ストアのインスタンス行を再利用します。
リクエストボディ(LinkLicenseRequest)
{
"licenseKey": "sqe_2xH7c0VqHk9LmZr1aPq4tN8bW6yD3sJfUe5o"
}
- 200
- リンクしました。ステータスは次のように表示されます
license.source: linked. - 400
invalid_license_key: 空、不正な形式、未知、または失効したキー。- 401
unauthorized: 管理トークンがないか、誤っている。- 409
license_from_flag: ブリッジは次の指定で起動されました--license-keyまたは--license-file、そのため、そのライセンスはこの API では管理されません。- 502
store_unreachable: sqlly.app に到達できなかったか、その応答を検証できませんでした。
401 応答の例
{
"error": "unauthorized",
"message": "management token missing or wrong"
}
/manage/license
このインストールのリンクを解除
このブリッジのインスタンススロットを解放し、sqlly.app 上のキーを失効させ(ベストエフォート)、保存されたキーを削除し、開いているすべてのセッションを閉じて、ブリッジを unlicensed.
- 204
- リンクを解除しました。
- 401
unauthorized: 管理トークンがないか、誤っている。- 404
not_linked: リンク済みのキーは保存されません。- 409
license_from_flag: ブリッジは次の指定で起動されました--license-keyまたは--license-file、そのため、そのライセンスはこの API では管理されません。
401 応答の例
{
"error": "unauthorized",
"message": "management token missing or wrong"
}
エンジン
資格情報形式が受け付けるデータベースエンジン。これにより、UI で一覧をハードコードする必要がなくなります。
/manage/engines
資格情報の形式が受け入れるエンジン
SQLly がサポートするすべてのデータベースエンジンと、 engine 認証情報ドキュメントに書き込む ID、既定のポート、そして server はファイルパスになり、 authentication.type 受け入れる値。
- 200
- エンジン。
- 401
unauthorized: 管理トークンがないか、誤っている。
200 応答の例
[
{
"id": "sql-server",
"name": "Microsoft SQL Server",
"defaultPort": 1433,
"fileBased": false,
"authentication": [
"sql-login",
"integrated",
"entra-browser",
"entra-device-code"
]
},
{
"id": "postgres",
"name": "PostgreSQL",
"defaultPort": 5432,
"fileBased": false,
"authentication": [
"sql-login"
]
},
{
"id": "sqlite",
"name": "SQLite",
"defaultPort": 0,
"fileBased": true,
"authentication": [
"none"
]
}
]
401 応答の例
{
"error": "unauthorized",
"message": "management token missing or wrong"
}
プロファイル
プロファイルは、名前付きの SQLly 認証情報ドキュメントです。ユーザーグループごとに表示される接続(とラベル)を定義します。記録の正式な保管場所はブリッジであり、シークレットがブラウザーに届くことはありません。
/manage/profiles
プロファイルを一覧表示
保存されているすべてのプロファイル (資格情報を除く)。
- 200
- プロファイル。
- 401
unauthorized: 管理トークンがないか、誤っている。
200 応答の例
[
{
"id": "analysts",
"name": "Analysts",
"connections": 2,
"updatedAt": "2026-10-14T15:02:11Z"
}
]
401 応答の例
{
"error": "unauthorized",
"message": "management token missing or wrong"
}
/manage/profiles/{id}
1 つのプロファイルを読む
プロファイルと、シークレットを含む完全なクレデンシャル文書: 呼び出し元は信頼できるサーバー側アプリです。
- id
- path · ^[A-Za-z0-9_-]{1,64}$ に一致する文字列 · 必須 - プロファイルの ID。
- 200
- プロファイル。
- 400
invalid_profile_id: id は 1〜64 文字で、使用できるのはA-Z a-z 0-9 _ -.- 401
unauthorized: 管理トークンがないか、誤っている。- 404
unknown_profile: その ID のプロファイルはありません。
401 応答の例
{
"error": "unauthorized",
"message": "management token missing or wrong"
}
404 応答の例
{
"error": "unknown_profile",
"message": "no profile with id analysts"
}
/manage/profiles/{id}
プロファイルの作成または置換
プロファイルを次の場所に保存します id (作成または置換)。資格情報ドキュメントは、書き込みが行われる前に完全に検証されます。パーサーが見つけた問題はすべて、次に返されます problems、無効なドキュメントは何も変更しません。ファイルベースのエンジン(SQLite、DuckDB)を含むドキュメントも、ブリッジが次で実行されていない限り、同様に拒否されます --allow-file-engines true、そのような接続を持つと、ユーザーはブリッジホスト上のファイルにアクセスできてしまうためです。すでに開いているセッションは、開始時のカタログのまま動作し、編集内容は次回の起動から反映されます。
- id
- path · ^[A-Za-z0-9_-]{1,64}$ に一致する文字列 · 必須 - プロファイルの ID。
リクエストボディ(PutProfileRequest)
{
"name": "Analysts",
"credentials": {
"format": "sqlly-credentials",
"version": 1,
"clients": [
{
"name": "Northwind Traders",
"color": "#1E88E5"
}
],
"environments": [
{
"name": "Production",
"color": "#C62828",
"safety": {
"only_allow_select": true
}
}
],
"sql_auth_accounts": [
{
"name": "Reader",
"username": "reader",
"password": "…"
}
],
"connections": [
{
"name": "Northwind",
"engine": "sql-server",
"server": "sql01.internal",
"database": "Northwind",
"environment": "production",
"client": "Northwind Traders",
"authentication": {
"type": "sql-login",
"account": "Reader"
},
"tls": {
"encrypt": true,
"trust_server_certificate": true
}
},
{
"name": "Warehouse",
"engine": "postgres",
"server": "dw.internal",
"database": "dw",
"environment": "production",
"client": "Northwind Traders",
"authentication": {
"type": "sql-login",
"account": "Reader"
},
"tls": {
"mode": "verify-full"
}
}
]
}
}
- 200
- 保存済み。
- 400
invalid_profile(次を付けてproblems: パーサーの問題、または各ファイルベースのエンジンが次の状態のとき--allow-file-enginesはオフです)、またはinvalid_profile_id.- 401
unauthorized: 管理トークンがないか、誤っている。- 500
storage: 状態ディレクトリに書き込めなかった。
400 応答の例
{
"error": "invalid_profile",
"message": "the credential document has 2 problems",
"problems": [
"connections[0].engine: unknown engine \"postgress\"",
"connections[1].authentication.pasword: unknown key"
]
}
401 応答の例
{
"error": "unauthorized",
"message": "management token missing or wrong"
}
/manage/profiles/{id}
プロファイルを削除
プロファイルを削除します。開いているセッションは開始時のカタログを保持し、このプロファイルの新しい起動トークンは次のエラーで拒否されます unknown_profile.
- id
- path · ^[A-Za-z0-9_-]{1,64}$ に一致する文字列 · 必須 - プロファイルの ID。
- 204
- 削除しました。
- 400
invalid_profile_id: id は 1〜64 文字で、使用できるのはA-Z a-z 0-9 _ -.- 401
unauthorized: 管理トークンがないか、誤っている。- 404
unknown_profile: その ID のプロファイルはありません。
401 応答の例
{
"error": "unauthorized",
"message": "management token missing or wrong"
}
404 応答の例
{
"error": "unknown_profile",
"message": "no profile with id analysts"
}
起動
ブラウザープレビューを起動 →
/manage/tokens
起動トークンを発行
次のユーザー向けに SQLly を開く、有効期間の短いトークンを作成します user を伴う profile、必要に応じてそのままクエリタブで開く(open、起動コンテキスト)。返された次を入れてください proxyUrl そして token SQLly を読み込むページ内に (globalThis.SQLLY_PROXY_URL / globalThis.SQLLY_PROXY_TOKEN)。トークンは有効期限が切れるまで(ページを再読み込みしても)再利用でき、プロファイルは発行時点のものが保存されます。
ユーザーは、開いているセッションや有効期限が切れていないトークンを持っている間、シートを占有します。すでにシートを持つユーザーのトークンを発行しても、シート数の制限で失敗することはありません。新しいユーザーのトークンを発行すると、次のエラーで失敗します seat_limit ライセンスの全シートが使用中のとき (ライセンス上のすべてのブリッジのユーザーを合計して数えます)。
リクエストボディ(MintTokenRequest)
{
"user": "dana.analyst",
"profile": "analysts",
"open": {
"connection": "Shop",
"database": "sales",
"title": "Big orders",
"script": "SELECT *\nFROM orders\nWHERE total > @min_total",
"parameters": {
"min_total": 500
},
"cursor": {
"line": 3,
"column": 7
}
}
}
- 201
- トークン。
- 400
invalid_user(空、または空白を含む。最大 128 文字)、invalid_profile(保存されたプロファイルがもう検証を通らない、またはファイルベースのエンジンを保持している場合で、--allow-file-enginesはオフです)、またはinvalid_open(起動コンテキストが、不明な接続、不明なフィールドや型、不正なパラメーター名や値、範囲外のカーソルを指定している、または上限を超えている場合。problemsそれぞれの誤りをパス付きで一覧表示します。例:open[1].cursor: …).- 401
unauthorized: 管理トークンがないか、誤っている。- 404
unknown_profile: その ID のプロファイルはありません。- 409
seat_limit: すべてのシートが使用中です。いずれか 1 つを解放してください(DELETE /manage/seats/{user})、またはより上位のプランを購入してください。- 503
license_not_ok: ライセンスが次の状態ではないokまたはgrace(失効、期限切れ、取り消し済み、未承認、ドメイン不一致、またはライセンスなし)。メッセージにどれに該当するかが表示されます。
201 応答の例
{
"token": "elt_q3J0n8w2Zx5rVb1kTq9yLs4dHf7cMa6p",
"expiresAt": "2026-10-14T15:12:11Z",
"proxyUrl": "wss://portal.example.com/sqlly/proxy",
"user": "dana.analyst",
"profile": "analysts",
"seatsUsed": 3,
"seats": 25,
"openTabs": 0
}
401 応答の例
{
"error": "unauthorized",
"message": "management token missing or wrong"
}
/manage/seats
使用中のシート
このブリッジでシートを保有しているユーザーと、その開いているセッション、有効なトークン。 seatsUsed 同じライセンスの他のブリッジについてsqlly.appが報告したユーザーも数えます。
- 200
- シート使用状況。
- 401
unauthorized: 管理トークンがないか、誤っている。
200 応答の例
{
"seats": 25,
"seatsUsed": 2,
"users": [
{
"user": "dana.analyst",
"activeSessions": 1,
"tokens": 1,
"since": "2026-10-14T15:02:11Z"
},
{
"user": "sam.support",
"activeSessions": 2,
"tokens": 1,
"since": "2026-10-14T14:40:03Z"
}
]
}
401 応答の例
{
"error": "unauthorized",
"message": "management token missing or wrong"
}
/manage/seats/{user}
ユーザーのシートを解放する
ユーザーのトークンを失効させ、セッションを閉じて、シートを即座に解放します。ユーザーがアプリからサインアウトしたとき、またはアクセスを失ったときに呼び出してください。シートを保有していないユーザーを解放してもエラーにはなりません。パスセグメントはパーセントデコードされます: a%2Fb ユーザーを解放します a/b.
- ユーザー
- path · 文字列 · 必須 - トークンを発行したユーザー ID(URL エンコード)。
- 204
- 解放しました。
- 400
bad_request: セグメントが有効なパーセントエンコーディングではない。- 401
unauthorized: 管理トークンがないか、誤っている。
401 応答の例
{
"error": "unauthorized",
"message": "management token missing or wrong"
}
接続
誰かが使う前に、接続が動作することを確認します。
/manage/test-connection
1 つの接続をテスト
接続を1つだけ含む認証情報ドキュメントに対して使い捨てのエンジンを実行し、単純なクエリを実行します。接続エラーは次のように報告されます ok: false エンジン自身のメッセージ (HTTP 200) で応答します。使えないドキュメントのときだけ HTTP エラーになります。
リクエストボディ(TestConnectionRequest)
{
"credentials": {
"format": "sqlly-credentials",
"version": 1,
"connections": [
{
"name": "Northwind",
"engine": "sql-server",
"server": "sql01.internal",
"database": "Northwind",
"authentication": {
"type": "sql-login",
"username": "reader",
"password": "…"
},
"tls": {
"encrypt": true,
"trust_server_certificate": true
}
}
]
}
}
- 200
- 結果(成功かどうか)。
- 400
invalid_profile: ドキュメントが無効なとき、接続がちょうど 1 つでないとき、またはファイルベースのエンジンを含むドキュメントが次の状態のとき--allow-file-enginesはオフです (参照:problems).- 401
unauthorized: 管理トークンがないか、誤っている。
200 応答の例
{
"ok": true,
"elapsedMs": 212,
"message": "Connected: SQL Server 17.0"
}
401 応答の例
{
"error": "unauthorized",
"message": "management token missing or wrong"
}
監査
クエリの監査証跡: セッションが実行したすべてのクエリと行の編集、実行したユーザー、対象の接続、終了のしかた。メモリ内と <state-dir>/queries.jsonl (SQL テキストを含む)。ただし、ブリッジが次を付けて実行されている場合は除きます --query-log false.
/manage/queries
クエリ監査証跡
ブリッジのセッションが実行したすべてのクエリと行編集を新しい順に表示します: 起動トークンのユーザーとプロファイル、指定された接続 (名前、サーバー、エンジン、データベース)、SQL テキスト (64 KiB で切り詰め、参照 sqlTruncated)、開始時刻、ステータスと所要時間、失敗した場合はエンジンのエラー。まだ実行中のリクエストは、次のステータスで一覧表示されます running; ライセンスが有効な状態でないために拒否されたリクエストは failed ライセンスメッセージとともに。セッションを閉じた時点で実行中だったものは cancelled エラーで session closed.
ブリッジは最新の --query-log-max-entries エントリ(デフォルトは20 000)をメモリ内と <state-dir>/queries.jsonl、そのため、再起動しても履歴は残ります。次を指定すると --query-log false 何も記録されず、応答は { "enabled": false, "queries": [] }.
- 上限
- query · integer - 返すエントリ数。1〜1000 に制限されます。
- ユーザー
- query · string - このユーザー ID のみ(完全一致、URL エンコード済み)。
- プロファイル
- query · string - このプロファイル ID のみ(完全一致)。
- 以降
- query · string (date-time) - 次の値をもつエントリのみ
atは、この RFC 3339 タイムスタンプ (URL エンコード) と同時かそれ以降です。 - ステータス
- query · QueryStatus - このステータスのエントリのみ。
- 200
- 一致したエントリ(新しい順)。
- 400
bad_request:limitは整数ではありません、sinceは RFC 3339 形式ではなく、statusが不明であるか、値が有効なパーセントエンコーディングではありません。- 401
unauthorized: 管理トークンがないか、誤っている。
200 応答の例
{
"enabled": true,
"total": 2,
"limit": 200,
"queries": [
{
"id": "q-7",
"sessionId": 12,
"kind": "query",
"at": "2026-10-14T15:04:09.120Z",
"user": "dana.analyst",
"profile": "analysts",
"profileName": "Analysts",
"connection": "Northwind",
"server": "sql01.internal",
"database": "Northwind",
"engine": "Microsoft SQL Server",
"sql": "SELECT TOP 100 * FROM Orders",
"sqlTruncated": false,
"status": "completed",
"durationMs": 184,
"error": null
},
{
"id": "q-6",
"sessionId": 12,
"kind": "query",
"at": "2026-10-14T15:03:51.004Z",
"user": "dana.analyst",
"profile": "analysts",
"profileName": "Analysts",
"connection": "Northwind",
"server": "sql01.internal",
"database": "Northwind",
"engine": "Microsoft SQL Server",
"sql": "SELECT * FROM Ordres",
"sqlTruncated": false,
"status": "failed",
"durationMs": 31,
"error": "Invalid object name 'Ordres'."
}
]
}
401 応答の例
{
"error": "unauthorized",
"message": "management token missing or wrong"
}
リンク
sqlly.app エンドポイント (サーバー) sqlly.app)は、インストールをライセンスにリンクするためのものです。コードを作成し、所有者がブラウザーで承認し、インストール固有のキーを一度受け取ってから、PUT /manage/license でブリッジに渡します。
/api/embedded/links
sqlly.app
トークンなし
インストールのリンクを開始します(sqlly.app)
匿名です。リンク要求を作成し、短いコード、アプリだけが知っているシークレット、ライセンス所有者が承認する URL を返します。コードを表示して開く linkUrl をオーナーに開いてもらい、続いて POST /api/embedded/links/token すべて pollIntervalSeconds 承認されるまで。リンクは15分後に期限が切れます。
リクエストボディ(CreateLinkRequest)
{
"name": "SQLly Embedded on portal-01",
"hostname": "portal-01",
"appVersion": "1.4.0"
}
- 201
- リンクを作成しました。
- 429
- レート制限されました。
- 503
link_unavailable: コードを割り当てられませんでした。もう一度お試しください。
201 応答の例
{
"linkId": "eml_Y2h9u0bQ1sXk4tWm8pZr3vLa",
"code": "K7Q-4MX",
"secret": "pW0r7…",
"linkUrl": "https://sqlly.app/embedded/link?code=K7Q-4MX",
"expiresAt": "2026-10-14T15:17:11Z",
"pollIntervalSeconds": 3
}
/api/embedded/links/token
sqlly.app
トークンなし
リンクされたキーをポーリングする(sqlly.app)
匿名です。リンクシークレットが認証情報です。所有者がまだ判断していない間は、次を返します 202 pending。承認されると、このインストール専用のライセンスキーが発行され、一度だけ返されます(リンクは使用済みになります)。そのキーを、次のコマンドでそのままブリッジに渡してください PUT /manage/license; 自分で保存しないでください。
リクエストボディ(LinkTokenRequest)
- 200
- 承認: キーを一度だけ。
- 202
- まだオーナーの承認待ちです。
- 401
wrong_secret.- 404
unknown_link.- 410
link_used,link_denied,link_expiredまたはlicense_revoked: このリンクは完了できません。新しいリンクを開始してください。- 429
- レート制限されました。
/api/embedded/public-key
sqlly.app
トークンなし
ライセンス署名用の公開鍵(sqlly.app)
sqlly.app がライセンス付与に署名する PEM 公開鍵。オペレーターはこれを、ブリッジにコンパイルされた鍵と比較できます。
- 200
- PEM テキスト。
- 503
signing_not_configured.
スキーマ
上記のオブジェクト群の定義は次のとおりです: swagger.json。1 つの ? が型の後ろに付くと、その値は null.
エラー
すべてのエラー応答。 error は安定した機械可読コードで、 message 管理者に見せられる文章です。
| フィールド | 型 | 説明 |
|---|---|---|
error * |
string |
|
message * |
string |
|
problems |
string[] |
含まれるのは invalid_profile: 認証情報パーサーが見つけたすべての問題。 |
LicenseState
ok そして grace クエリを処理します。それ以外の状態では、SQLly がユーザーに表示するメッセージとともに処理を拒否します。
次のいずれか: ok grace stale not_admitted expired revoked domain_mismatch unlicensed
StatusReport
| フィールド | 型 | 説明 |
|---|---|---|
version |
string |
ブリッジバージョン。 |
instanceId |
string |
sqlly.app から見たこのブリッジプロセスの ID。 |
mode |
connected | offline |
|
license |
LicenseReport |
|
seatsUsed |
integer |
ライセンスのすべてのブリッジをまたいで使用中のシート。 |
activeSessions |
integer |
このブリッジで開いている SQLly セッション。 |
proxyUrl |
string |
ブラウザーが使用する WebSocket URL(--public-url). |
allowLocalhostOrigins |
boolean |
|
storeUrl |
string |
|
allowFileEngines |
boolean |
プロファイルにファイルベースのエンジンを含められるかどうか(--allow-file-engines). |
LicenseReport
許可は署名付きのグラントに由来し、署名のないデータに由来することはありません。
| フィールド | 型 | 説明 |
|---|---|---|
state |
LicenseState |
|
source |
flag | file | linked | none |
flag: --license-key; file: --license-file; linked: PUT /manage/license によって保存される; none: ライセンスなし。 |
licenseId |
string? |
|
plan |
string? |
プランID、または custom 独自の条件で発行されたライセンスについて |
planName |
string? |
|
status |
string? |
sqlly.app でのステータス(最終チェックイン時点): active、grace、expired、revoked、domain_mismatch。 |
seats |
integer |
ライセンスで許可される同時ユーザー数。 |
sessionsPerSeat |
integer |
1 人のユーザーが保持できる SQLly タブの数。 |
instances |
integer |
同時に実行できるブリッジ (接続済みライセンス。オフラインは 0)。 |
domain |
string? |
バインドされたドメイン。ブラウザーはこのドメインまたはそのサブドメインから接続する必要があります。 |
periodEnd |
string? |
有料期間の終了日 (ISO 8601)。 |
graceEnd |
string? |
猶予期間中に設定される値: ブリッジがクエリの提供を停止する時刻。 |
daysRemaining |
integer? |
ブリッジが使えなくなるまでの残り日数。 |
lastCheckinAt |
string (date-time)? |
|
staleAt |
string (date-time)? |
チェックインが 1 度も成功しない場合に、ブリッジが失効するまでの時間 (最後に成功した許可 + 40 分)。 |
licenseFile |
string? |
オフライン: 使用中のライセンスファイル。 |
message |
string? |
何か問題があるときにユーザーに表示される文(猶予カウントダウンも含みます)。 |
fromCache |
boolean |
sqlly.app に到達できなかったためにブリッジがキャッシュ済みのグラントから起動した場合は true になります。 |
features |
string[] |
LinkLicenseRequest
| フィールド | 型 | 説明 |
|---|---|---|
licenseKey * |
string |
次で始まるキー sqe_. |
EngineInfo
| フィールド | 型 | 説明 |
|---|---|---|
id |
string |
その engine 認証情報ドキュメント用の値。 |
name |
string |
|
defaultPort |
integer |
|
fileBased |
boolean |
server はファイルパスになり、サインインは適用されません。 |
authentication |
string[] |
承認済み authentication.type 値。 |
ProfileSummary
| フィールド | 型 | 説明 |
|---|---|---|
id |
string |
|
name |
string |
|
connections |
integer |
ドキュメント内の接続数。 |
updatedAt |
string (date-time) |
StoredProfile
| フィールド | 型 | 説明 |
|---|---|---|
id |
string |
|
name |
string |
|
credentials |
CredentialDocument |
|
updatedAt |
string (date-time) |
PutProfileRequest
| フィールド | 型 | 説明 |
|---|---|---|
name * |
string |
SQLly でユーザーに表示される表示名。 |
credentials * |
CredentialDocument |
CredentialDocument
SQLly の認証情報ドキュメント(SQLly の「ファイル → 接続のインポート」と同じ形式)。未知のキーはエラーになるため、タイプミスは無視されずに報告されます。完全なリファレンス: sqlly.app/docs (資格情報ファイルの形式)。
| フィールド | 型 | 説明 |
|---|---|---|
format * |
sqlly-credentials |
|
version * |
1 |
|
clients |
Label[] |
|
projects |
Label[] |
|
environments |
Label[] |
|
sql_auth_accounts |
SharedLogin[] |
|
tunnel_profiles |
object[] |
|
connections |
Connection[] |
ラベル
| フィールド | 型 | 説明 |
|---|---|---|
name * |
string |
|
color |
string |
#RGB、#RRGGBB、#RRGGBBAA。 |
image |
string |
data: URI または素の base64 形式のアイコン(PNG、JPEG、GIF、WebP、BMP、ICO、SVG、最大 1 MB)。 |
safety |
object |
指定したフラグだけが変更されます。 |
SharedLogin
| フィールド | 型 | 説明 |
|---|---|---|
name * |
string |
|
username * |
string |
|
password |
string |
接続
| フィールド | 型 | 説明 |
|---|---|---|
name * |
string |
|
engine * |
string |
GET /manage/engines で取得した ID。 |
server * |
string |
ホスト、IP、host\instance、または SQLite/DuckDB 用のファイルパス。 |
port |
integer |
|
database |
string |
|
environment |
string |
local、dev、test、staging、production、または未設定。 |
client |
string |
クライアントラベル名。 |
project |
string |
プロジェクトラベル名。 |
authentication |
Authentication |
|
tls |
object |
|
timeout_seconds |
integer |
|
statement_timeout_seconds |
integer |
|
application_name |
string |
|
safety |
object |
|
favorite |
boolean |
|
startup_sql |
string |
|
tunnel_profile |
string |
|
transport |
object |
インラインのプロキシ、SSH、kube ホップ。 |
masking |
object |
{ include: [...], exclude: [...] } 列マスキングルール。 |
認証
| フィールド | 型 | 説明 |
|---|---|---|
type * |
sql-login | integrated | entra-browser | entra-device-code | aws-rds-iam | gcp-cloud-sql-iam | auth-token | none |
|
username |
string |
|
password |
string |
|
account |
string |
sql_auth_accounts で共有されたログインの名前。 |
region |
string |
|
profile |
string |
|
token |
string |
MintTokenRequest
| フィールド | 型 | 説明 |
|---|---|---|
user * |
string |
ユーザーを識別する不変のID(空白は不可)。シート数は一意のユーザーごとにカウントされます。 |
profile * |
string |
プロファイル ID。 |
ttlSeconds |
integer |
トークンの有効期間。既定値は --token-ttl-seconds (600) で、10 秒~24 時間の範囲に制限されます。 |
open |
LaunchTab | LaunchTab[] |
起動コンテキスト: セッション開始時に SQLly が開く、1 つまたは最大 8 つのクエリタブ。トークンが最初に受け入れたセッションがそれを受け取り、再読み込みやその後のセッションでは受け取りません。発行時にプロファイルに対して検証されます(400 invalid_open)。ユーザーが「実行」を押すまで、何も実行されません。ガイド: sqlly.app/docs/embedded/launch-context |
LaunchCursor
1 回の起動で開くクエリタブ 1 つ。必要なのは script、 connection、またはその両方。
| フィールド | 型 | 説明 |
|---|---|---|
connection |
string |
トークンのプロファイル内の接続を、名前(大文字小文字を区別せず、一意である必要があります)または ID で指定します。プロファイルに接続が 1 つだけの場合は省略可能です。複数あって名前を指定しない場合、タブは接続に紐づけられない状態で開きます。 |
database |
string |
接続のデフォルトの代わりに切り替え先とするデータベース。 |
title |
string |
タブのタイトル。 |
script |
string |
読み込む SQL(そのまま。最大 256 KiB、CRLF は LF に変換されます)。 |
parameters |
object |
スクリプトの @name パラメーター。名前をキーとします (次の有無を問わず @)。素の値の型は推論されます(整数は int、その他の数値は decimal、真偽値は bool、文字列は text、null は empty)。明示的に指定するには { type, value } 選べます。スクリプトで宣言されていないパラメータには -- sqlly param: 行。値は SQLly のパラメーターストリップに表示され、アプリ側で SQL に埋め込まれることはありません。 |
cursor |
LaunchCursor |
起動トークンは、1 つのプロファイルで 1 人のユーザー向けに SQLly を開きます。シートは同時利用ユーザー数を指します。
| フィールド | 型 | 説明 |
|---|---|---|
type |
text | int | decimal | bool | date | datetime | time | uuid | json | binary |
|
value |
string | number | boolean |
ページに渡される起動トークン。経由:
キャレットの位置: script、1 起点です。列は文字数で数え、行末の 1 つ先になることもあります。
| フィールド | 型 | 説明 |
|---|---|---|
line |
integer |
|
column |
integer |
MintedToken
| フィールド | 型 | 説明 |
|---|---|---|
token |
string |
|
expiresAt |
string (date-time) |
|
proxyUrl |
string |
|
user |
string |
|
profile |
string |
|
seatsUsed |
integer |
このユーザーを含む使用中のシート |
seats |
integer |
|
openTabs |
integer |
セッションが開くタブの数(起動コンテキストがない場合は 0)。 |
SeatsReport
| フィールド | 型 | 説明 |
|---|---|---|
seats |
integer |
|
seatsUsed |
integer |
|
users |
UserSeat[] |
ユーザーシート
| フィールド | 型 | 説明 |
|---|---|---|
user |
string |
|
activeSessions |
integer |
|
tokens |
integer |
有効期限が切れていない起動トークン。 |
since |
string (date-time) |
TestConnectionRequest
| フィールド | 型 | 説明 |
|---|---|---|
credentials * |
CredentialDocument |
TestOutcome
| フィールド | 型 | 説明 |
|---|---|---|
ok |
boolean |
|
elapsedMs |
integer |
|
message |
string |
エンジン自身のメッセージ(成功または失敗)。 |
QueryStatus
running エンジンが応答するまで。その後 completed, failed (参照 error)、または cancelled (ユーザーによるもの、または session closed).
次のいずれか: running completed failed cancelled
QueryEntry
監査される 1 件のリクエスト。
| フィールド | 型 | 説明 |
|---|---|---|
id |
string |
エンジンリクエスト ID。セッション内で一意です。 |
sessionId |
integer |
ブラウザーセッションに対するブリッジ側の ID。 |
kind |
query | row-edit |
|
at |
string (date-time) |
リクエストがブリッジに到達した時刻。 |
user |
string |
起動トークンのユーザー ID。 |
profile |
string |
起動トークンのプロファイルID。 |
profileName |
string |
|
connection |
string |
プロファイルに設定された接続の名前。 |
server |
string |
|
database |
string? |
プロファイルがデータベースを固定している場合はそのデータベース、そうでない場合はリクエストで指定されたデータベース。 |
engine |
string |
エンジンの表示名。 |
sql |
string |
SQL テキスト、または row edit: <op> 行の編集用です。64 KiB で切り詰められます。 |
sqlTruncated |
boolean |
|
status |
QueryStatus |
|
durationMs |
integer? |
実行中は Null になります。 |
error |
string? |
エンジンのエラー failed; session closed セッション終了によって打ち切られたリクエスト用。 |
QueryListing
| フィールド | 型 | 説明 |
|---|---|---|
enabled |
boolean |
ブリッジが次の指定付きで実行されている場合は False --query-log false; それから queries は常に空です。 |
queries |
QueryEntry[] |
新しい順。 |
total |
integer |
フィルターに一致するエントリのうち、次を適用する前の limit 適用されました。 |
limit |
integer |
適用されたページサイズ(1-1000)。 |
CreateLinkRequest
| フィールド | 型 | 説明 |
|---|---|---|
name |
string |
承認ページと、所有者の Embedded ページに表示されます。 |
hostname |
string |
|
appVersion |
string |
CreateLinkResponse
| フィールド | 型 | 説明 |
|---|---|---|
linkId |
string |
|
code |
string |
これを所有者に見せて、一致していることを確認してもらってください。 |
secret |
string |
サーバー側で保持してください。キーを収集します。 |
linkUrl |
string |
オーナーが承認できるよう、これを開いてください。 |
expiresAt |
string (date-time) |
|
pollIntervalSeconds |
integer |
LinkTokenRequest
| フィールド | 型 | 説明 |
|---|---|---|
linkId * |
string |
|
secret * |
string |
LinkPending
| フィールド | 型 | 説明 |
|---|---|---|
status |
pending |
|
expiresAt |
string (date-time) |
LinkApproved
| フィールド | 型 | 説明 |
|---|---|---|
status |
approved |
|
licenseKey |
string |
一度だけ返されます。PUT /manage/license に渡してください。 |
keyId |
string |
|
licenseId |
string |
|
plan |
string |
プランID、または custom. |
planName |
string |
|
accountEmail |
string |
* 必須