Skip to main content
POST
カスタムドメインの設定
このルートを使用するには、少なくとも Standard プランが必要です。 同一アカウントで1つのドメインを複数のアプリケーションに割り当てることができます(ロードバランシング)。Standard では最大2アプリケーション、Pro では5、Enterprise では10まで割り当て可能です。ロードバランサーの一覧取得を参照してください。
string
必須
アカウントの API キーです。これはアカウント設定で確認できます。
既存のカスタムドメインを置き換える場合、同一アカウントの別のアプリケーションがそのホスト名を引き続き使用していない限り、新しいドメインを割り当てる前にエッジ上で以前のホスト名が解放されます。割り当て時と削除時(custom: "@")のどちらでも同じバリデーションが実行されます。ワークスペースで共有されているアプリケーションでは、呼び出し元にワークスペースの Administrator ロールまたはオーナー権限が必要です。 ドメインは同時に 1 つのアカウントにしか割り当てられません。すでに別のアカウントが保持しているホスト名を割り当てようとすると DOMAIN_ALREADY_EXISTS が返されます。自分のアプリケーション全体に設定されているホスト名を確認するには、ドメイン一覧の取得を参照してください。割り当て後は、DNS レコードの取得で必要なバリデーションレコードを取得してください。

パラメータ

string
必須
アプリケーションのID。アプリケーションのダッシュボードのURLで確認できます。
string
必須
割り当てる完全修飾ドメイン名、またはアプリケーションの現在のカスタムドメインを削除する場合は @。Square Cloud のドメイン(squareweb.appsquarecloud.app、…)は使用できません。

レスポンス

string
呼び出しが成功したかどうかを示します。成功した場合は success、失敗した場合は error です。
失敗時、レスポンスにはエラー code が含まれます: