認証

DeployGate API は2種類の認証方式をサポートしています。認証が失敗した場合、401 の他、エンドポイントに応じて 403 または 404 を返します。特に404 については非公開リソースの存在推測を防ぐための動作です。

Header 認証

推奨する認証方式です。Authorization ヘッダーを付与してください。

curl -H "Authorization: token <DEPLOYGATE-API-TOKEN>" --url "<endpoint>"

パラメータ認証

クエリパラメータ、またはフォームデータを利用した認証方式です。

curl --url "<endpoint>?token=<DEPLOYGATE-API-TOKEN>"
curl -X POST -F token=<DEPLOYGATE-API-TOKEN> --url "<endpoint>"

❗️

リクエストボディの存在する GET リクエストは動作保証対象外です

特に curl を利用する際はご注意ください。以下のリクエストは GET でリクエストボディを保持するため、その動作を保証致しません。Header 認証またはクエリパラメータによる認証が必要です。

$ curl -X GET -F token=<DEPLOYGATE-API-TOKEN> --url "<endpoint>"