Platform API リファレンス

Table of Contents [expand]

概要
アカウント
アカウントの義務不履行
アカウント機能
アドオン
アドオンアクション
アドオンアタッチメント
アドオン設定
アドオンプランアクション
アドオンリージョン機能
アドオンサービス
アドオン Webhook
アドオン Webhook 配信
アドオン Webhook イベント
許可されたアドオンサービス
アプリ
アプリ機能
アプリの設定
アプリの移動
アプリの Webhook
アプリの Webhook 配信
アプリの Webhook イベント
追跡記録アーカイブ
追跡記録イベント
ビルド
buildpack インストール
共同作業者
環境設定
クレジット
ドメイン
dyno
dyno サイズ
エンタープライズアカウント
エンタープライズアカウントの毎日の使用状況
エンタープライズアカウントメンバー
エンタープライズアカウントの毎月の使用状況
フィルター
フォーメーション
世代
ID プロバイダー
インバウンドルールセット
請求書
請求書の住所
キー
ログドレイン
ログセッション
OAuth 認証
OAuth クライアント
OAuth 許可
OAuth トークン
OCI イメージ
PasswordReset
ピアリング
ピアリング情報
アクセス許可エンティティ
パイプライン
パイプラインビルド
パイプラインの環境設定
パイプラインカップリング
パイプラインデプロイ
パイプラインプロモーション
パイプラインプロモーションターゲット
パイプラインリリース
パイプラインスタック
パイプラインの移動
プラン
速度制限
リージョン
リリース
レビューアプリ
レビューアプリの設定
slug
SMS の番号
SNI エンドポイント
ソース
Space
Space アクセス
Space のネットワークアドレス変換
Space トポロジー
Space の転送
スタック
チーム
チームアドオン
チームアプリ
チームアプリの共同作業者
チームアプリアクセス許可
チームの毎日の使用状況
チームの義務不履行
チーム機能
チーム招待
チーム請求書
チームメンバー
チームの毎月の使用状況
チーム設定
チーム Space
テレメトリードレイン
テストケース
テストノード
テスト実行
ユーザー設定
Private Spaces VPN

この記事の英語版に更新があります。ご覧の翻訳には含まれていない変更点があるかもしれません。

最終更新日 2025年03月07日(金)

概要

Platform API は、開発者が Heroku を自動化したり、拡張したり、他のサービスと組み合わせたりできるようにします。Platform API を使用すると、プログラムでアプリを作成したり、アドオンをプロビジョニングしたり、以前には Heroku CLI や Dashboard でしか達成できなかったその他のタスクを実行したりできます。使用を開始する方法についての詳細は、「Platform API スターターガイド」を参照してください。

認証

アカウントへの自分自身やサードパーティからのアクセスを承認したり取り消したりするには、OAuth を使用します。詳細は、OAuth の記事を参照してください。

個人用のスクリプトでは HTTP ベアラー認証を使用することもできますが、サードパーティサービスには OAuth をお勧めします。HTTP ベアラー認証は、各リクエストに対する承認ヘッダーとして渡される API トークン (Authorization: Bearer 01234567-89ab-cdef-0123-456789abcdef など) を使用して構成する必要があります。詳細は、クイックスタートガイドを参照してください。

キャッシング

すべての応答には、返されるリソースの特定のバージョンを識別する ETag (エンティティタグ) ヘッダーが含まれています。この値を使用すると、リクエストを繰り返し、If-None-Match ヘッダーで ETag 値を渡すことによって、リソースへの変更を確認できます。リソースが変更されていない場合は、空の本体を持つ 304 Not Modified ステータスが返されます。リソースが変更されている場合、そのリクエストの処理は正常に続行されます。

クライアント

クライアントは HTTPS を使用して api.heroku.com へのリクエストをアドレス指定し、Accept: application/vnd.heroku+json; version=3 Accept ヘッダーを指定する必要があります。クライアントは追跡やデバッグを容易にするために User-Agent ヘッダーを指定します。

CORS

Platform API は、すべてのドメインから処理される JavaScript を使用してリクエストをブラウザから送信できるように、オリジン間リソース共有 (CORS) をサポートしています。

スキーマ

この API には、API 経由で使用可能なリソース、リソースの URL、リソースの表現方法、リソースによりサポートされている操作が記述された、マシンで解読可能な JSON スキーマがあります。このスキーマには、cURL を使用してアクセスできます。

$ curl https://api.heroku.com/schema \
-H "Accept: application/vnd.heroku+json; version=3"

{
  "description": "The platform API empowers developers to automate, extend and combine Heroku with other services.",
  "definitions": {
  ...
  }
}

cURL の例

実験を容易にするために cURL の例が提供されています。変数の値は、環境変数を使用して操作できるように、$SOMETHING として表されています。これらの例では、-n オプションを使用して ~/.netrc ファイルの資格情報をフェッチします。このファイルには、次のような api.heroku.com のエントリが含まれています。

machine api.heroku.com
  login {your-email}
  password {your-api-token}

Heroku の V3 API は HTTP Accept ヘッダー経由でのみアクセスできるため、簡単にアクセスできるように cURL エイリアスを作成すると便利な場合もあります。

alias c3='curl -n -H "Accept: application/vnd.heroku+json; version=3"'

カスタムの型

名前	JSON の型	説明
date-time	文字列	ISO8601 形式のタイムスタンプ
uuid	文字列	8-4-4-4-12 形式の UUID

データの整合性

一意の ID とより人間が理解できる属性の両方をリソースの参照に使用できます。たとえば、アプリを参照するには name または id を使用できます。人間が理解できるバージョンの方が便利かもしれませんが、あいまいさを回避するために id の方をお勧めします。

以前の応答の ETag 値を持つ If-Match ヘッダーを渡して、あるリソースが最後に受信されてから変更されていないことを保証することができます。リソースが変更されている場合は、412 Precondition Failed 応答を受信します。リソースが変更されていない場合、そのリクエストの処理は正常に続行されます。

エラー

失敗した応答には、対応するステータスと、特定のエラーに関するより詳細な情報を含む JSON 本体が格納されます。ID の詳細な例については、エラー応答を参照してください。

エラー属性

名前	型	説明	例
id	文字列	生成されたエラーの ID	`"rate_limit"`
message	文字列	生成されたエラーのエンドユーザーメッセージ	`"Your account reached the API limit. Please wait a few minutes before making new requests"`
url	文字列	エラーに関するより詳細な情報を含む参照 URL	`https://devcenter.heroku.com/articles/platform-api-reference#rate-limits`

url は関連する場合にのみ含まれ、応答内に存在しない可能性があることに注意してください。

エラー応答

HTTP/1.1 429 Too Many Requests

{
  "id":       "rate_limit",
  "message":  "Your account reached the API rate limit\nPlease wait a few minutes before making new requests",
  "url":      "https://devcenter.heroku.com/articles/platform-api-reference#rate-limits"
}

エスケープ

一部の属性はテキストフィールドです。XSS の欠陥を防止するために、これらのフィールドはエスケープされません。そのデータのエスケープはクライアントに任されています。

メソッド

メソッド	使用法
DELETE	既存のオブジェクトを破棄するために使用されます。
GET	一覧と個々のオブジェクトを取得するために使用されます。
HEAD	既存のオブジェクトに関するメタデータを取得するために使用されます。
PATCH	既存のオブジェクトを更新するために使用されます。
POST	新しいオブジェクトを作成するために使用されます。

メソッドの上書き

一部のメソッドをサポートしていないクライアントを使用している場合は、POST を使用し、X-Http-Method-Override ヘッダーを目的のメソッドに設定することによって上書きできます。たとえば、PATCH リクエストを実行するには、ヘッダー X-Http-Method-Override: PATCH を使用して POST を実行します。

パラメータ

アクションに対して指定できる値は、オプションの値と必須の値に分けられます。各値に対して予期される種類が指定され、一覧表示されていない値は不変と見なします。パラメータは JSON でエンコードし、リクエスト本体で渡します。

範囲

一覧のリクエストは、返される値の範囲を示す Content-Range ヘッダーを返します。大きな一覧には、取得するための追加のリクエストが必要になる可能性があります。一覧の応答が切り捨てられている場合は、206 Partial Content ステータスと設定された Next-Range ヘッダーを受信します。次の範囲を取得するには、Range ヘッダーを前のリクエストの Next-Range ヘッダーの値に設定してそのリクエストを繰り返します。

1 つの範囲で返される値の数は、Range ヘッダー内の max キーを使用して制御できます。たとえば、最初の 10 個の値だけを取得するには、ヘッダー Range: id ..; max=10; を設定します。maxはまた、Next-Range を繰り返すときにも渡すことができます。デフォルトのページサイズは 200 であり、最大ページサイズは 1000 です。

一覧の応答内の値をソートするために使用されるプロパティは変更できます。デフォルトのプロパティは id です (Range: id ..; など)。一覧の応答をソートするために使用できるその他のプロパティを確認するには、Accept-Ranges ヘッダーを調べてください。たとえば、apps リソースの場合は、id または name のどちらかでソートできます。

$ curl -i -n -X GET https://api.heroku.com/apps \
-H "Accept: application/vnd.heroku+json; version=3"

...
Accept-Ranges: id, name
...

リソース一覧の応答のデフォルトのソート順は昇順です。Range ヘッダーで order キーを渡すことによって、降順のソート順を選択できます。

$ curl -i -n -X GET https://api.heroku.com/apps \
-H "Accept: application/vnd.heroku+json; version=3" -H "Range: name ..; order=desc;"

max キーとの組み合わせは、次のようになります。

$ curl -i -n -X GET https://api.heroku.com/apps \
-H "Accept: application/vnd.heroku+json; version=3" \
-H "Range: name ..; order=desc,max=10;"

速度制限

この API では、不正操作やバグの多いコードから保護するために、各ユーザーが 1 時間あたりに実行できるリクエストの数が制限されます。各アカウントには、最大 4500 のトークンを保持できるリクエストトークンのプールがあります。各 API 呼び出しは、このプールから 1 つのトークンを削除します。トークンは、おおよそ 1 分あたり 75 (1 時間あたり 4500) から最大 4500 までの速度でアカウントプールに追加されます。残りのトークンがない場合、使用可能なトークンが増えるまで、それ以降の呼び出しは 429 Too Many Requests を返します。

RateLimit-Remaining 応答ヘッダーを使用して、現在のトークン数を確認できます。また、速度制限エンドポイントにクエリを実行してトークン数を取得することもできます。速度制限エンドポイントへのリクエストは制限のカウントに入りません。アカウントが速度制限されていることがわかったが、その原因が不明な場合は、Heroku ダッシュボードのアカウントページで API キーを循環させることを検討してください。

リクエスト ID

追跡を容易にするために、各 API 応答の Request-Id ヘッダーには一意のリクエスト ID が含まれています。問題を報告する場合は、この値を指定すると、より迅速に問題を特定して解決策を提供することがより簡単になります。

応答

この API によって返される値は、ステータスコードの例と関連ヘッダー (一般的な HTTP ヘッダーは省略される) を含むセクションと、JSON 本体の例を含むセクション (存在する場合) に分割されます。

応答ヘッダー

ヘッダー	説明
RateLimit-Remaining	現在の間隔に残っている許可されたリクエスト

安定性

Heroku Platform API スキーマ内の各リソースには、stability 属性が注釈として付けられます。これは、3 つの値 prototype、development、production のいずれかに設定されます。この属性には、そのリソースに対して設定されている変更管理ポリシーが反映されます。これらのポリシーの完全な説明については、Dev Center API の互換性に関する記事を参照してください。

ステータス

応答の結果は、返されたステータスによって判定できます。

成功した応答

ステータス	説明
200 OK	リクエストが成功しました。
201 Created	リソースが作成されました (たとえば、新しいアプリが作成されたか、またはアドオンがプロビジョニングされました)。
202 Accepted	リクエストが受け付けられましたが、処理はまだ完了していません。
206 Partial Content	リクエストが成功しましたが、これは部分的な応答にすぎません。範囲を参照してください。

エラー応答

エラー応答は、2 つのクラスに分けることができます。クライアントエラーは不正な形式のリクエストから発生するため、クライアントが対処します。Heroku エラーはサーバー側の問題から発生するため、内部的に対処する必要があります。

クライアントエラーの応答

ステータス	エラー ID	説明
400 Bad Request	`bad_request`	無効なリクエストです。使用法を検証して再試行してください。
401 Unauthorized	`unauthorized`	リクエストが認証されませんでした。API トークンがないか、無効か、または期限切れです。
402 Payment Required	`delinquent`	不払いの結果としてアカウントが滞納となったか、または続行するにはアカウントの支払方法を確認する必要があります。
403 Forbidden	`forbidden`	リクエストが承認されませんでした。指定された資格情報では指定されたリソースへのアクセスが提供されません。
403 Forbidden	`suspended`	リクエストが承認されませんでした。アカウントまたはアプリケーションが中断されました。
404 Not Found	`not_found`	リクエストが失敗しました。指定されたリソースが存在しません。
406 Not Acceptable	`not_acceptable`	リクエストが失敗しました。`Accept: application/vnd.heroku+json; version=3` ヘッダーを設定して再試行してください。
409 Conflict	`conflict`	リクエストが失敗しました。推奨される解決策については、応答本体を参照してください。
410 Gone	`gone`	要求されたリソースがこの場所では見つからなくなっています。代わりの方法については、Platform API リファレンスを参照してください。
416 Requested Range Not Satisfiable	`requested_range_not_satisfiable`	リクエストが失敗しました。`Content-Range` ヘッダーを検証して再試行してください。
422 Unprocessable Entity	`invalid_params`	リクエストが失敗しました。パラメータを検証して再試行してください。
422 Unprocessable Entity	`verification_needed`	リクエストが失敗しました。リソースを利用する前に、Heroku Dashboard で請求情報を入力してください。
429 Too Many Requests	`rate_limit`	リクエストが失敗しました。速度制限のリセットを待ってから再試行してください。速度制限を参照してください。

Heroku エラーの応答

ステータス	説明
500 Internal Server Error	エラーが発生しました。当社に通知されますが、問題が続く場合は、サポートにお問い合わせください。
503 Service Unavailable	API が使用不可です。詳細は、応答本体または Heroku Status を確認してください。

バージョン管理

この API の現在のバージョンはバージョン 3 です。バージョン管理についての詳細は、API の互換性ポリシーに関する記事を参照してください。

アカウント

安定性: 本番環境

アカウントは、Heroku プラットフォームを使用するためにサインアップしている個人を表します。

属性

名前	型	説明	例
allow_tracking	ブール値	サードパーティ Web アクティビティの追跡を許可するかどうかデフォルト値: `true`	`true`
beta	ブール値	Heroku のベータ機能を利用することが許可されているかどうか	`false`
country_of_residence	null 許容文字列	アカウント所有者が存在する国	`"United States"`
created_at	日時	アカウントが作成された日時	`"2012-01-01T12:00:00Z"`
default_organization	null 許容オブジェクト	デフォルトで選択されるチーム	`null`
default_organization:id	UUID	チームの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
default_organization:name	文字列	チームの一意の名前	`"example"`
default_team	null 許容オブジェクト	デフォルトで選択されるチーム	`null`
default_team:id	UUID	チームの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
default_team:name	文字列	チームの一意の名前	`"example"`
delinquent_at	null 許容日時	アカウントが滞納となった日時	`"2012-01-01T12:00:00Z"`
email	メール	アカウントの一意のメールアドレス	`"username@example.com"`
federated	ブール値	ユーザーがフェデレーションされ、ID プロバイダーに属しているかどうか	`false`
id	UUID	アカウントの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
identity_provider	null 許容オブジェクト	フェデレーションされているユーザーの ID プロバイダーの詳細	`null`
identity_provider:id	UUID	この ID プロバイダーの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
identity_provider:name	文字列	この ID プロバイダーのユーザーにわかりやすい一意識別子	`"acme-sso"`
identity_provider:organization:name	文字列	チームの一意の名前	`"example"`
identity_provider:owner:id	UUID	所有者の一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
identity_provider:owner:name	文字列	所有者の名前	`"acme"`
identity_provider:owner:type	文字列	所有者のタイプ次のうちのいずれか: `"team"`、`"enterprise-account"`	`"team"`
identity_provider:team:name	文字列	チームの一意の名前	`"example"`
last_login	null 許容日時	アカウントが Heroku で最後に承認された日時	`"2012-01-01T12:00:00Z"`
name	null 許容文字列	アカウント所有者のフルネーム	`"Tina Edmonds"`
sms_number	null 許容文字列	アカウントの SMS の番号	`"+1 *-*-1234"`
suspended_at	null 許容日時	アカウントが中断された日時	`"2012-01-01T12:00:00Z"`
two_factor_authentication	ブール値	アカウントで 2 要素認証が有効になっているかどうか	`false`
updated_at	日時	アカウントが更新された日時	`"2012-01-01T12:00:00Z"`
verified	ブール値	アカウントが請求情報で確認されているかどうか	`false`

アカウントの情報

アカウントに関する情報。

GET /account

curl の例

$ curl -n https://api.heroku.com/account \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "allow_tracking": true,
  "beta": false,
  "created_at": "2012-01-01T12:00:00Z",
  "email": "username@example.com",
  "federated": false,
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "identity_provider": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "acme-sso",
    "team": {
      "name": "example"
    },
    "organization": {
      "name": "example"
    },
    "owner": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "acme",
      "type": "team"
    }
  },
  "last_login": "2012-01-01T12:00:00Z",
  "name": "Tina Edmonds",
  "sms_number": "+1 ***-***-1234",
  "suspended_at": "2012-01-01T12:00:00Z",
  "delinquent_at": "2012-01-01T12:00:00Z",
  "two_factor_authentication": false,
  "updated_at": "2012-01-01T12:00:00Z",
  "verified": false,
  "country_of_residence": "United States",
  "default_organization": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  },
  "default_team": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  }
}

アカウントの更新

アカウントを更新します。

PATCH /account

オプションパラメータ

名前	型	説明	例
allow_tracking	ブール値	サードパーティ Web アクティビティの追跡を許可するかどうかデフォルト値: `true`	`true`
beta	ブール値	Heroku のベータ機能を利用することが許可されているかどうか	`false`
name	null 許容文字列	アカウント所有者のフルネーム	`"Tina Edmonds"`

curl の例

$ curl -n -X PATCH https://api.heroku.com/account \
  -d '{
  "allow_tracking": true,
  "beta": false,
  "name": "Tina Edmonds"
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "allow_tracking": true,
  "beta": false,
  "created_at": "2012-01-01T12:00:00Z",
  "email": "username@example.com",
  "federated": false,
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "identity_provider": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "acme-sso",
    "team": {
      "name": "example"
    },
    "organization": {
      "name": "example"
    },
    "owner": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "acme",
      "type": "team"
    }
  },
  "last_login": "2012-01-01T12:00:00Z",
  "name": "Tina Edmonds",
  "sms_number": "+1 ***-***-1234",
  "suspended_at": "2012-01-01T12:00:00Z",
  "delinquent_at": "2012-01-01T12:00:00Z",
  "two_factor_authentication": false,
  "updated_at": "2012-01-01T12:00:00Z",
  "verified": false,
  "country_of_residence": "United States",
  "default_organization": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  },
  "default_team": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  }
}

アカウントの削除

アカウントを削除します。このアクションは元に戻せないことに注意してください。注意: このエンドポイントでは、HTTP_HEROKU_PASSWORD または HTTP_HEROKU_PASSWORD_BASE64 ヘッダーがユーザーアカウントに対して正しく設定されている必要があります。

DELETE /account

curl の例

$ curl -n -X DELETE https://api.heroku.com/account \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "allow_tracking": true,
  "beta": false,
  "created_at": "2012-01-01T12:00:00Z",
  "email": "username@example.com",
  "federated": false,
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "identity_provider": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "acme-sso",
    "team": {
      "name": "example"
    },
    "organization": {
      "name": "example"
    },
    "owner": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "acme",
      "type": "team"
    }
  },
  "last_login": "2012-01-01T12:00:00Z",
  "name": "Tina Edmonds",
  "sms_number": "+1 ***-***-1234",
  "suspended_at": "2012-01-01T12:00:00Z",
  "delinquent_at": "2012-01-01T12:00:00Z",
  "two_factor_authentication": false,
  "updated_at": "2012-01-01T12:00:00Z",
  "verified": false,
  "country_of_residence": "United States",
  "default_organization": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  },
  "default_team": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  }
}

ユーザーごとのアカウント情報

アカウントに関する情報。

GET /users/{account_email_or_id_or_self}

curl の例

$ curl -n https://api.heroku.com/users/$ACCOUNT_EMAIL_OR_ID_OR_SELF \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "allow_tracking": true,
  "beta": false,
  "created_at": "2012-01-01T12:00:00Z",
  "email": "username@example.com",
  "federated": false,
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "identity_provider": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "acme-sso",
    "team": {
      "name": "example"
    },
    "organization": {
      "name": "example"
    },
    "owner": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "acme",
      "type": "team"
    }
  },
  "last_login": "2012-01-01T12:00:00Z",
  "name": "Tina Edmonds",
  "sms_number": "+1 ***-***-1234",
  "suspended_at": "2012-01-01T12:00:00Z",
  "delinquent_at": "2012-01-01T12:00:00Z",
  "two_factor_authentication": false,
  "updated_at": "2012-01-01T12:00:00Z",
  "verified": false,
  "country_of_residence": "United States",
  "default_organization": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  },
  "default_team": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  }
}

ユーザーごとのアカウントの更新

アカウントを更新します。

PATCH /users/{account_email_or_id_or_self}

オプションパラメータ

名前	型	説明	例
allow_tracking	ブール値	サードパーティ Web アクティビティの追跡を許可するかどうかデフォルト値: `true`	`true`
beta	ブール値	Heroku のベータ機能を利用することが許可されているかどうか	`false`
name	null 許容文字列	アカウント所有者のフルネーム	`"Tina Edmonds"`

curl の例

$ curl -n -X PATCH https://api.heroku.com/users/$ACCOUNT_EMAIL_OR_ID_OR_SELF \
  -d '{
  "allow_tracking": true,
  "beta": false,
  "name": "Tina Edmonds"
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "allow_tracking": true,
  "beta": false,
  "created_at": "2012-01-01T12:00:00Z",
  "email": "username@example.com",
  "federated": false,
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "identity_provider": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "acme-sso",
    "team": {
      "name": "example"
    },
    "organization": {
      "name": "example"
    },
    "owner": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "acme",
      "type": "team"
    }
  },
  "last_login": "2012-01-01T12:00:00Z",
  "name": "Tina Edmonds",
  "sms_number": "+1 ***-***-1234",
  "suspended_at": "2012-01-01T12:00:00Z",
  "delinquent_at": "2012-01-01T12:00:00Z",
  "two_factor_authentication": false,
  "updated_at": "2012-01-01T12:00:00Z",
  "verified": false,
  "country_of_residence": "United States",
  "default_organization": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  },
  "default_team": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  }
}

ユーザーごとのアカウントの削除

DELETE /users/{account_email_or_id_or_self}

curl の例

$ curl -n -X DELETE https://api.heroku.com/users/$ACCOUNT_EMAIL_OR_ID_OR_SELF \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "allow_tracking": true,
  "beta": false,
  "created_at": "2012-01-01T12:00:00Z",
  "email": "username@example.com",
  "federated": false,
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "identity_provider": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "acme-sso",
    "team": {
      "name": "example"
    },
    "organization": {
      "name": "example"
    },
    "owner": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "acme",
      "type": "team"
    }
  },
  "last_login": "2012-01-01T12:00:00Z",
  "name": "Tina Edmonds",
  "sms_number": "+1 ***-***-1234",
  "suspended_at": "2012-01-01T12:00:00Z",
  "delinquent_at": "2012-01-01T12:00:00Z",
  "two_factor_authentication": false,
  "updated_at": "2012-01-01T12:00:00Z",
  "verified": false,
  "country_of_residence": "United States",
  "default_organization": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  },
  "default_team": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  }
}

アカウントの義務不履行

安定性: 開発

Heroku アカウントは支払いの確認がとれていないため義務不履行となります。請求書が未払いのままの場合は、義務不履行アカウントを中断し、削除します。

属性

名前	型	説明	例
scheduled_deletion_time	null 許容日時	義務不履行によりアカウントを削除するスケジュール済み時刻	`"2024-01-01T12:00:00Z"`
scheduled_suspension_time	null 許容日時	義務不履行によりアカウントを中断するスケジュール済み時刻	`"2024-01-01T12:00:00Z"`

アカウントの義務不履行情報

アカウントの義務不履行情報。

GET /account/delinquency

curl の例

$ curl -n https://api.heroku.com/account/delinquency \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "scheduled_suspension_time": "2024-01-01T12:00:00Z",
  "scheduled_deletion_time": "2024-01-01T12:00:00Z"
}

アカウント機能

安定性: 本番環境

アカウント機能は、Heroku のアカウントに対して有効または無効にできる Heroku Labs 機能を表します。

属性

名前	型	説明	例
created_at	日時	アカウント機能が作成された日時	`"2012-01-01T12:00:00Z"`
description	文字列	アカウント機能の説明	`"Causes account to example."`
display_name	文字列	ユーザーで解読可能な機能名	`"My Feature"`
doc_url	文字列	アカウント機能のドキュメント URL	`"http://devcenter.heroku.com/articles/example"`
enabled	ブール値	アカウント機能が有効になっているかどうか	`true`
feedback_email	文字列	機能に関するフィードバックを送信するためのメール	`"feedback@heroku.com"`
id	UUID	アカウント機能の一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
name	文字列	アカウント機能の一意の名前	`"name"`
state	文字列	アカウント機能の状態	`"public"`
updated_at	日時	アカウント機能が更新された日時	`"2012-01-01T12:00:00Z"`

アカウント機能の情報

既存のアカウント機能に関する情報。

GET /account/features/{account_feature_id_or_name}

curl の例

$ curl -n https://api.heroku.com/account/features/$ACCOUNT_FEATURE_ID_OR_NAME \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "created_at": "2012-01-01T12:00:00Z",
  "description": "Causes account to example.",
  "doc_url": "http://devcenter.heroku.com/articles/example",
  "enabled": true,
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "name": "name",
  "state": "public",
  "updated_at": "2012-01-01T12:00:00Z",
  "display_name": "My Feature",
  "feedback_email": "feedback@heroku.com"
}

アカウント機能の一覧

既存のアカウント機能を一覧表示します。

Range ヘッダーの容認可能な順序の値は id または name です。

GET /account/features

curl の例

$ curl -n https://api.heroku.com/account/features \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: id, name
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "created_at": "2012-01-01T12:00:00Z",
    "description": "Causes account to example.",
    "doc_url": "http://devcenter.heroku.com/articles/example",
    "enabled": true,
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "name",
    "state": "public",
    "updated_at": "2012-01-01T12:00:00Z",
    "display_name": "My Feature",
    "feedback_email": "feedback@heroku.com"
  }
]

アカウント機能の更新

既存のアカウント機能を更新します。

PATCH /account/features/{account_feature_id_or_name}

必須パラメータ

名前	型	説明	例
enabled	ブール値	アカウント機能が有効になっているかどうか	`true`

curl の例

$ curl -n -X PATCH https://api.heroku.com/account/features/$ACCOUNT_FEATURE_ID_OR_NAME \
  -d '{
  "enabled": true
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "created_at": "2012-01-01T12:00:00Z",
  "description": "Causes account to example.",
  "doc_url": "http://devcenter.heroku.com/articles/example",
  "enabled": true,
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "name": "name",
  "state": "public",
  "updated_at": "2012-01-01T12:00:00Z",
  "display_name": "My Feature",
  "feedback_email": "feedback@heroku.com"
}

アドオン

安定性: 本番環境

アドオンは、1 つ以上のアプリにプロビジョニングおよびアタッチされているアドオンを表します。

属性

名前	型	説明	例
actions:action	文字列	SSO 経由で送信される実行すべきアクションの識別子	`"example"`
actions:id	UUID	一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
actions:label	文字列	Dashboard に表示される表示テキスト	`"Example"`
actions:requires_owner	ブール値	アクションにユーザーがアプリを所有していることが必要かどうか	`true`
actions:url	文字列	アクションの代わりに使用する絶対 URL	`"http://example.com?resource_id=:resource_id"`
addon_service	文字列	アドオンサービスは、アプリにプロビジョニングできるアドオンを表します。アドオンサービスの下のエンドポイントには認証なしでアクセスできます。
app:id	UUID	アプリの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
app:name	文字列	アプリの一意の名前パターン: `^[a-z][a-z0-9-]{1,28}[a-z0-9]$`	`"example"`
billed_price	null 許容オブジェクト	請求される価格	`null`
billed_price:cents	整数	プランの単位あたりの価格 (セント)	`0`
billed_price:contract	ブール値	価格が毎月のアドオン請求以外の契約でネゴシエートされるかどうか	`false`
billed_price:unit	文字列	プランの価格の単位	`"month"`
billing_entity:id	UUID	請求エンティティの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
billing_entity:name	文字列	請求エンティティの名前	`"example"`
billing_entity:type	文字列	請求エンティティのオブジェクトのタイプ。新しいタイプがいつでも許可されます。次のうちのいずれか: `"app"`、`"team"`	`"app"`
config_vars	配列	このアドオンによって所有アプリに公開される環境設定	`["FOO","BAZ"]`
created_at	日時	アドオンが作成された日時	`"2012-01-01T12:00:00Z"`
id	UUID	アドオンの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
name	文字列	アドオンのグローバル固有名パターン: `^[a-zA-Z][A-Za-z0-9_-]+$`	`"acme-inc-primary-database"`
plan	文字列	プランは、アプリに追加できるアドオンのさまざまな設定を表します。アドオンサービスの下のエンドポイントには認証なしでアクセスできます。
provider_id	文字列	このアドオンの ID とそのプロバイダー	`"abcd1234"`
provision_message	文字列	プロビジョニングメッセージ	`"example"`
state	文字列	アドオンのライフサイクルでの状態次のうちのいずれか: `"provisioning"`、`"provisioned"`、`"deprovisioned"`	`"provisioned"`
updated_at	日時	アドオンが更新された日時	`"2012-01-01T12:00:00Z"`
web_url	null 許容 URI	アドオンの Web インターフェース (ダッシュボードなど) にログインするための URL	`"https://postgres.heroku.com/databases/01234567-89ab-cdef-0123-456789abcdef"`

アドオンの一覧

すべての既存のアドオンを一覧表示します。

Range ヘッダーの容認可能な順序の値は id または name です。

GET /addons

curl の例

$ curl -n https://api.heroku.com/addons \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: id, name
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "actions": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "label": "Example",
      "action": "example",
      "url": "http://example.com?resource_id=:resource_id",
      "requires_owner": true
    },
    "addon_service": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "heroku-postgresql"
    },
    "billing_entity": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "example",
      "type": "app"
    },
    "app": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "example"
    },
    "billed_price": {
      "cents": 0,
      "contract": false,
      "unit": "month"
    },
    "config_vars": [
      "FOO",
      "BAZ"
    ],
    "created_at": "2012-01-01T12:00:00Z",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "acme-inc-primary-database",
    "plan": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "heroku-postgresql:dev"
    },
    "provider_id": "abcd1234",
    "provision_message": "example",
    "state": "provisioned",
    "updated_at": "2012-01-01T12:00:00Z",
    "web_url": "https://postgres.heroku.com/databases/01234567-89ab-cdef-0123-456789abcdef"
  }
]

アドオンの情報

既存のアドオンに関する情報。

GET /addons/{add_on_id_or_name}

curl の例

$ curl -n https://api.heroku.com/addons/$ADD_ON_ID_OR_NAME \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "actions": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "label": "Example",
    "action": "example",
    "url": "http://example.com?resource_id=:resource_id",
    "requires_owner": true
  },
  "addon_service": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "heroku-postgresql"
  },
  "billing_entity": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example",
    "type": "app"
  },
  "app": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  },
  "billed_price": {
    "cents": 0,
    "contract": false,
    "unit": "month"
  },
  "config_vars": [
    "FOO",
    "BAZ"
  ],
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "name": "acme-inc-primary-database",
  "plan": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "heroku-postgresql:dev"
  },
  "provider_id": "abcd1234",
  "provision_message": "example",
  "state": "provisioned",
  "updated_at": "2012-01-01T12:00:00Z",
  "web_url": "https://postgres.heroku.com/databases/01234567-89ab-cdef-0123-456789abcdef"
}

アドオンの作成

新しいアドオンを作成します。

POST /apps/{app_id_or_name}/addons

必須パラメータ

名前	型	説明	例
plan	文字列	このプランの一意識別子または名前	`"01234567-89ab-cdef-0123-456789abcdef"` または `"heroku-postgresql:dev"`

オプションパラメータ

名前	型	説明	例
attachment:name	文字列	このアプリへのこのアドオンアタッチメントの一意の名前	`"DATABASE"`
config	オブジェクト	カスタムのアドオンプロビジョニングオプション	`{"db-version":"1.2.3"}`
confirm	文字列	確認のための請求エンティティの名前	`"example"`
name	文字列	アドオンのグローバル固有名パターン: `^[a-zA-Z][A-Za-z0-9_-]+$`	`"acme-inc-primary-database"`

curl の例

$ curl -n -X POST https://api.heroku.com/apps/$APP_ID_OR_NAME/addons \
  -d '{
  "attachment": {
    "name": "DATABASE_FOLLOWER"
  },
  "config": {
    "db-version": "1.2.3"
  },
  "confirm": "example",
  "plan": "01234567-89ab-cdef-0123-456789abcdef",
  "name": "acme-inc-primary-database"
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 201 Created
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "actions": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "label": "Example",
    "action": "example",
    "url": "http://example.com?resource_id=:resource_id",
    "requires_owner": true
  },
  "addon_service": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "heroku-postgresql"
  },
  "billing_entity": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example",
    "type": "app"
  },
  "app": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  },
  "billed_price": {
    "cents": 0,
    "contract": false,
    "unit": "month"
  },
  "config_vars": [
    "FOO",
    "BAZ"
  ],
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "name": "acme-inc-primary-database",
  "plan": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "heroku-postgresql:dev"
  },
  "provider_id": "abcd1234",
  "provision_message": "example",
  "state": "provisioned",
  "updated_at": "2012-01-01T12:00:00Z",
  "web_url": "https://postgres.heroku.com/databases/01234567-89ab-cdef-0123-456789abcdef"
}

アドオンの削除

既存のアドオンを削除します。

DELETE /apps/{app_id_or_name}/addons/{add_on_id_or_name}

curl の例

$ curl -n -X DELETE https://api.heroku.com/apps/$APP_ID_OR_NAME/addons/$ADD_ON_ID_OR_NAME \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "actions": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "label": "Example",
    "action": "example",
    "url": "http://example.com?resource_id=:resource_id",
    "requires_owner": true
  },
  "addon_service": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "heroku-postgresql"
  },
  "billing_entity": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example",
    "type": "app"
  },
  "app": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  },
  "billed_price": {
    "cents": 0,
    "contract": false,
    "unit": "month"
  },
  "config_vars": [
    "FOO",
    "BAZ"
  ],
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "name": "acme-inc-primary-database",
  "plan": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "heroku-postgresql:dev"
  },
  "provider_id": "abcd1234",
  "provision_message": "example",
  "state": "provisioned",
  "updated_at": "2012-01-01T12:00:00Z",
  "web_url": "https://postgres.heroku.com/databases/01234567-89ab-cdef-0123-456789abcdef"
}

アプリごとのアドオンの情報

既存のアドオンに関する情報。

GET /apps/{app_id_or_name}/addons/{add_on_id_or_name}

curl の例

$ curl -n https://api.heroku.com/apps/$APP_ID_OR_NAME/addons/$ADD_ON_ID_OR_NAME \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "actions": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "label": "Example",
    "action": "example",
    "url": "http://example.com?resource_id=:resource_id",
    "requires_owner": true
  },
  "addon_service": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "heroku-postgresql"
  },
  "billing_entity": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example",
    "type": "app"
  },
  "app": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  },
  "billed_price": {
    "cents": 0,
    "contract": false,
    "unit": "month"
  },
  "config_vars": [
    "FOO",
    "BAZ"
  ],
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "name": "acme-inc-primary-database",
  "plan": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "heroku-postgresql:dev"
  },
  "provider_id": "abcd1234",
  "provision_message": "example",
  "state": "provisioned",
  "updated_at": "2012-01-01T12:00:00Z",
  "web_url": "https://postgres.heroku.com/databases/01234567-89ab-cdef-0123-456789abcdef"
}

アプリごとのアドオンの一覧

アプリの既存のアドオンを一覧表示します。

Range ヘッダーの容認可能な順序の値は id または name です。

GET /apps/{app_id_or_name}/addons

curl の例

$ curl -n https://api.heroku.com/apps/$APP_ID_OR_NAME/addons \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: id, name
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "actions": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "label": "Example",
      "action": "example",
      "url": "http://example.com?resource_id=:resource_id",
      "requires_owner": true
    },
    "addon_service": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "heroku-postgresql"
    },
    "billing_entity": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "example",
      "type": "app"
    },
    "app": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "example"
    },
    "billed_price": {
      "cents": 0,
      "contract": false,
      "unit": "month"
    },
    "config_vars": [
      "FOO",
      "BAZ"
    ],
    "created_at": "2012-01-01T12:00:00Z",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "acme-inc-primary-database",
    "plan": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "heroku-postgresql:dev"
    },
    "provider_id": "abcd1234",
    "provision_message": "example",
    "state": "provisioned",
    "updated_at": "2012-01-01T12:00:00Z",
    "web_url": "https://postgres.heroku.com/databases/01234567-89ab-cdef-0123-456789abcdef"
  }
]

アドオンの更新

アドオンプランを変更します。一部のアドオンではプランの変更がサポートされない場合があります。その場合は、エラーが返されます。

PATCH /apps/{app_id_or_name}/addons/{add_on_id_or_name}

必須パラメータ

名前	型	説明	例
plan	文字列	このプランの一意識別子または名前	`"01234567-89ab-cdef-0123-456789abcdef"` または `"heroku-postgresql:dev"`

オプションパラメータ

名前	型	説明	例
name	文字列	アドオンのグローバル固有名パターン: `^[a-zA-Z][A-Za-z0-9_-]+$`	`"acme-inc-primary-database"`

curl の例

$ curl -n -X PATCH https://api.heroku.com/apps/$APP_ID_OR_NAME/addons/$ADD_ON_ID_OR_NAME \
  -d '{
  "name": "acme-inc-primary-database",
  "plan": "01234567-89ab-cdef-0123-456789abcdef"
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "actions": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "label": "Example",
    "action": "example",
    "url": "http://example.com?resource_id=:resource_id",
    "requires_owner": true
  },
  "addon_service": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "heroku-postgresql"
  },
  "billing_entity": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example",
    "type": "app"
  },
  "app": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  },
  "billed_price": {
    "cents": 0,
    "contract": false,
    "unit": "month"
  },
  "config_vars": [
    "FOO",
    "BAZ"
  ],
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "name": "acme-inc-primary-database",
  "plan": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "heroku-postgresql:dev"
  },
  "provider_id": "abcd1234",
  "provision_message": "example",
  "state": "provisioned",
  "updated_at": "2012-01-01T12:00:00Z",
  "web_url": "https://postgres.heroku.com/databases/01234567-89ab-cdef-0123-456789abcdef"
}

ユーザーごとのアドオンの一覧

ユーザーがアクセスできるすべての既存のアドオンを一覧表示します。

Range ヘッダーの容認可能な順序の値は id または name です。

GET /users/{account_email_or_id_or_self}/addons

curl の例

$ curl -n https://api.heroku.com/users/$ACCOUNT_EMAIL_OR_ID_OR_SELF/addons \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: id, name
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "actions": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "label": "Example",
      "action": "example",
      "url": "http://example.com?resource_id=:resource_id",
      "requires_owner": true
    },
    "addon_service": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "heroku-postgresql"
    },
    "billing_entity": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "example",
      "type": "app"
    },
    "app": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "example"
    },
    "billed_price": {
      "cents": 0,
      "contract": false,
      "unit": "month"
    },
    "config_vars": [
      "FOO",
      "BAZ"
    ],
    "created_at": "2012-01-01T12:00:00Z",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "acme-inc-primary-database",
    "plan": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "heroku-postgresql:dev"
    },
    "provider_id": "abcd1234",
    "provision_message": "example",
    "state": "provisioned",
    "updated_at": "2012-01-01T12:00:00Z",
    "web_url": "https://postgres.heroku.com/databases/01234567-89ab-cdef-0123-456789abcdef"
  }
]

チームごとのアドオンの一覧

すべてのチームアプリにわたって使用されるアドオンを一覧表示します。

Range ヘッダーの容認可能な順序の値は id または name です。

GET /teams/{team_name_or_id}/addons

curl の例

$ curl -n https://api.heroku.com/teams/$TEAM_NAME_OR_ID/addons \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: id, name
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "actions": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "label": "Example",
      "action": "example",
      "url": "http://example.com?resource_id=:resource_id",
      "requires_owner": true
    },
    "addon_service": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "heroku-postgresql"
    },
    "billing_entity": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "example",
      "type": "app"
    },
    "app": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "example"
    },
    "billed_price": {
      "cents": 0,
      "contract": false,
      "unit": "month"
    },
    "config_vars": [
      "FOO",
      "BAZ"
    ],
    "created_at": "2012-01-01T12:00:00Z",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "acme-inc-primary-database",
    "plan": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "heroku-postgresql:dev"
    },
    "provider_id": "abcd1234",
    "provision_message": "example",
    "state": "provisioned",
    "updated_at": "2012-01-01T12:00:00Z",
    "web_url": "https://postgres.heroku.com/databases/01234567-89ab-cdef-0123-456789abcdef"
  }
]

アドオンの解決

名前からアドオンを解決し、オプションでアプリ名を渡します。一致が存在する場合は、少なくとも 1 つのアドオン (完全一致) または多数のアドオンを返します。

POST /actions/addons/resolve

必須パラメータ

名前	型	説明	例
addon	文字列	アドオンのグローバル固有名パターン: `^[a-zA-Z][A-Za-z0-9_-]+$`	`"acme-inc-primary-database"`

オプションパラメータ

名前	型	説明	例
addon_service	文字列	このアドオンサービスの一意の名前	`"heroku-postgresql"`
app	文字列	アプリの一意の名前パターン: `^[a-z][a-z0-9-]{1,28}[a-z0-9]$`	`"example"`

curl の例

$ curl -n -X POST https://api.heroku.com/actions/addons/resolve \
  -d '{
  "addon": "acme-inc-primary-database",
  "app": "example",
  "addon_service": "heroku-postgresql"
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "actions": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "label": "Example",
      "action": "example",
      "url": "http://example.com?resource_id=:resource_id",
      "requires_owner": true
    },
    "addon_service": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "heroku-postgresql"
    },
    "billing_entity": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "example",
      "type": "app"
    },
    "app": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "example"
    },
    "billed_price": {
      "cents": 0,
      "contract": false,
      "unit": "month"
    },
    "config_vars": [
      "FOO",
      "BAZ"
    ],
    "created_at": "2012-01-01T12:00:00Z",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "acme-inc-primary-database",
    "plan": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "heroku-postgresql:dev"
    },
    "provider_id": "abcd1234",
    "provision_message": "example",
    "state": "provisioned",
    "updated_at": "2012-01-01T12:00:00Z",
    "web_url": "https://postgres.heroku.com/databases/01234567-89ab-cdef-0123-456789abcdef"
  }
]

アドオンアクション

安定性: 開発

アドオンアクションは、アドオンのプロビジョニングとプロビジョニング解除のライフサイクル操作です。これにより、アドオンプロバイダーはバックグラウンドでアドオンをプロビジョニング (解除) し、後でプロビジョニング (解除) が完了したら戻って報告できます。

アドオンアクションのプロビジョニング

アドオンを使用のためにプロビジョニング済みとマークします。

POST /addons/{add_on_id_or_name}/actions/provision

curl の例

$ curl -n -X POST https://api.heroku.com/addons/$ADD_ON_ID_OR_NAME/actions/provision \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "actions": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "label": "Example",
    "action": "example",
    "url": "http://example.com?resource_id=:resource_id",
    "requires_owner": true
  },
  "addon_service": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "heroku-postgresql"
  },
  "billing_entity": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example",
    "type": "app"
  },
  "app": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  },
  "billed_price": {
    "cents": 0,
    "contract": false,
    "unit": "month"
  },
  "config_vars": [
    "FOO",
    "BAZ"
  ],
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "name": "acme-inc-primary-database",
  "plan": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "heroku-postgresql:dev"
  },
  "provider_id": "abcd1234",
  "provision_message": "example",
  "state": "provisioned",
  "updated_at": "2012-01-01T12:00:00Z",
  "web_url": "https://postgres.heroku.com/databases/01234567-89ab-cdef-0123-456789abcdef"
}

アドオンアクションのプロビジョニング解除

アドオンをプロビジョニング解除済みとマークします。

POST /addons/{add_on_id_or_name}/actions/deprovision

curl の例

$ curl -n -X POST https://api.heroku.com/addons/$ADD_ON_ID_OR_NAME/actions/deprovision \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "actions": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "label": "Example",
    "action": "example",
    "url": "http://example.com?resource_id=:resource_id",
    "requires_owner": true
  },
  "addon_service": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "heroku-postgresql"
  },
  "billing_entity": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example",
    "type": "app"
  },
  "app": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  },
  "billed_price": {
    "cents": 0,
    "contract": false,
    "unit": "month"
  },
  "config_vars": [
    "FOO",
    "BAZ"
  ],
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "name": "acme-inc-primary-database",
  "plan": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "heroku-postgresql:dev"
  },
  "provider_id": "abcd1234",
  "provision_message": "example",
  "state": "provisioned",
  "updated_at": "2012-01-01T12:00:00Z",
  "web_url": "https://postgres.heroku.com/databases/01234567-89ab-cdef-0123-456789abcdef"
}

アドオンアタッチメント

安定性: プロトタイプ

アドオンアタッチメントは、アプリと、そのアプリにアクセス権が与えられたアドオンの間の接続を表します。

属性

名前	型	説明	例
addon:app:id	UUID	アプリの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
addon:app:name	文字列	アプリの一意の名前パターン: `^[a-z][a-z0-9-]{1,28}[a-z0-9]$`	`"example"`
addon:id	UUID	アドオンの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
addon:name	文字列	アドオンのグローバル固有名パターン: `^[a-zA-Z][A-Za-z0-9_-]+$`	`"acme-inc-primary-database"`
app:id	UUID	アプリの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
app:name	文字列	アプリの一意の名前パターン: `^[a-z][a-z0-9-]{1,28}[a-z0-9]$`	`"example"`
created_at	日時	アドオンアタッチメントが作成された日時	`"2012-01-01T12:00:00Z"`
id	UUID	このアドオンアタッチメントの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
log_input_url	null 許容文字列	アドオンのログに書き込むためのアドオンパートナーの URL	`"https://token:t.abcdef12-3456-7890-abcd-ef1234567890@1.us.logplex.io/logs"`
name	文字列	このアプリへのこのアドオンアタッチメントの一意の名前	`"DATABASE"`
namespace	null 許容文字列	アタッチメントの名前空間	`"role:analytics"`
updated_at	日時	アドオンアタッチメントが更新された日時	`"2012-01-01T12:00:00Z"`
web_url	null 許容 URI	アタッチされたアプリのコンテキストでアドオンの Web インターフェースにログインするための URL	`"https://postgres.heroku.com/databases/01234567-89ab-cdef-0123-456789abcdef"`

アドオンアタッチメントの作成

新しいアドオンアタッチメントを作成します。

POST /addon-attachments

必須パラメータ

名前	型	説明	例
addon	文字列	アドオンの一意識別子またはグローバル名	`"01234567-89ab-cdef-0123-456789abcdef"` または `"acme-inc-primary-database"`
app	文字列	アプリの一意識別子または名前	`"01234567-89ab-cdef-0123-456789abcdef"` または `"example"`

オプションパラメータ

名前	型	説明	例
confirm	文字列	確認のための所有アプリの名前	`"example"`
name	文字列	このアプリへのこのアドオンアタッチメントの一意の名前	`"DATABASE"`
namespace	null 許容文字列	アタッチメントの名前空間	`"role:analytics"`

curl の例

$ curl -n -X POST https://api.heroku.com/addon-attachments \
  -d '{
  "addon": "01234567-89ab-cdef-0123-456789abcdef",
  "app": "01234567-89ab-cdef-0123-456789abcdef",
  "confirm": "example",
  "name": "DATABASE",
  "namespace": "role:analytics"
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 201 Created
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "addon": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "acme-inc-primary-database",
    "app": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "example"
    }
  },
  "app": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  },
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "name": "DATABASE",
  "namespace": "role:analytics",
  "updated_at": "2012-01-01T12:00:00Z",
  "web_url": "https://postgres.heroku.com/databases/01234567-89ab-cdef-0123-456789abcdef",
  "log_input_url": "https://token:t.abcdef12-3456-7890-abcd-ef1234567890@1.us.logplex.io/logs"
}

アドオンアタッチメントの削除

既存のアドオンアタッチメントを削除します。

DELETE /addon-attachments/{add_on_attachment_id}

curl の例

$ curl -n -X DELETE https://api.heroku.com/addon-attachments/$ADD_ON_ATTACHMENT_ID \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "addon": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "acme-inc-primary-database",
    "app": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "example"
    }
  },
  "app": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  },
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "name": "DATABASE",
  "namespace": "role:analytics",
  "updated_at": "2012-01-01T12:00:00Z",
  "web_url": "https://postgres.heroku.com/databases/01234567-89ab-cdef-0123-456789abcdef",
  "log_input_url": "https://token:t.abcdef12-3456-7890-abcd-ef1234567890@1.us.logplex.io/logs"
}

アドオンアタッチメントの情報

既存のアドオンアタッチメントに関する情報。

GET /addon-attachments/{add_on_attachment_id}

curl の例

$ curl -n https://api.heroku.com/addon-attachments/$ADD_ON_ATTACHMENT_ID \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "addon": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "acme-inc-primary-database",
    "app": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "example"
    }
  },
  "app": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  },
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "name": "DATABASE",
  "namespace": "role:analytics",
  "updated_at": "2012-01-01T12:00:00Z",
  "web_url": "https://postgres.heroku.com/databases/01234567-89ab-cdef-0123-456789abcdef",
  "log_input_url": "https://token:t.abcdef12-3456-7890-abcd-ef1234567890@1.us.logplex.io/logs"
}

アドオンアタッチメントの一覧

既存のアドオンアタッチメントを一覧表示します。

Range ヘッダーの唯一の容認可能な順序の値は id です。

GET /addon-attachments

curl の例

$ curl -n https://api.heroku.com/addon-attachments \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: id
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "addon": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "acme-inc-primary-database",
      "app": {
        "id": "01234567-89ab-cdef-0123-456789abcdef",
        "name": "example"
      }
    },
    "app": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "example"
    },
    "created_at": "2012-01-01T12:00:00Z",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "DATABASE",
    "namespace": "role:analytics",
    "updated_at": "2012-01-01T12:00:00Z",
    "web_url": "https://postgres.heroku.com/databases/01234567-89ab-cdef-0123-456789abcdef",
    "log_input_url": "https://token:t.abcdef12-3456-7890-abcd-ef1234567890@1.us.logplex.io/logs"
  }
]

アドオンごとのアドオンアタッチメントの一覧

アドオンの既存のアドオンアタッチメントを一覧表示します。

Range ヘッダーの唯一の容認可能な順序の値は id です。

GET /addons/{add_on_id_or_name}/addon-attachments

curl の例

$ curl -n https://api.heroku.com/addons/$ADD_ON_ID_OR_NAME/addon-attachments \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: id
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "addon": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "acme-inc-primary-database",
      "app": {
        "id": "01234567-89ab-cdef-0123-456789abcdef",
        "name": "example"
      }
    },
    "app": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "example"
    },
    "created_at": "2012-01-01T12:00:00Z",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "DATABASE",
    "namespace": "role:analytics",
    "updated_at": "2012-01-01T12:00:00Z",
    "web_url": "https://postgres.heroku.com/databases/01234567-89ab-cdef-0123-456789abcdef",
    "log_input_url": "https://token:t.abcdef12-3456-7890-abcd-ef1234567890@1.us.logplex.io/logs"
  }
]

アプリごとのアドオンアタッチメントの一覧

アプリの既存のアドオンアタッチメントを一覧表示します。

Range ヘッダーの唯一の容認可能な順序の値は id です。

GET /apps/{app_id_or_name}/addon-attachments

curl の例

$ curl -n https://api.heroku.com/apps/$APP_ID_OR_NAME/addon-attachments \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: id
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "addon": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "acme-inc-primary-database",
      "app": {
        "id": "01234567-89ab-cdef-0123-456789abcdef",
        "name": "example"
      }
    },
    "app": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "example"
    },
    "created_at": "2012-01-01T12:00:00Z",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "DATABASE",
    "namespace": "role:analytics",
    "updated_at": "2012-01-01T12:00:00Z",
    "web_url": "https://postgres.heroku.com/databases/01234567-89ab-cdef-0123-456789abcdef",
    "log_input_url": "https://token:t.abcdef12-3456-7890-abcd-ef1234567890@1.us.logplex.io/logs"
  }
]

アプリごとのアドオンアタッチメントの情報

アプリの既存のアドオンアタッチメントに関する情報。

GET /apps/{app_id_or_name}/addon-attachments/{add_on_attachment_id_or_name}

curl の例

$ curl -n https://api.heroku.com/apps/$APP_ID_OR_NAME/addon-attachments/$ADD_ON_ATTACHMENT_ID_OR_NAME \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "addon": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "acme-inc-primary-database",
    "app": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "example"
    }
  },
  "app": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  },
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "name": "DATABASE",
  "namespace": "role:analytics",
  "updated_at": "2012-01-01T12:00:00Z",
  "web_url": "https://postgres.heroku.com/databases/01234567-89ab-cdef-0123-456789abcdef",
  "log_input_url": "https://token:t.abcdef12-3456-7890-abcd-ef1234567890@1.us.logplex.io/logs"
}

アドオンアタッチメントの解決

名前からアドオンアタッチメントを解決し、オプションでアプリ名を渡します。一致が存在する場合は、少なくとも 1 つのアドオンアタッチメント (完全一致) または多数のアドオンアタッチメントを返します。

POST /actions/addon-attachments/resolve

必須パラメータ

名前	型	説明	例
addon_attachment	文字列	このアプリへのこのアドオンアタッチメントの一意の名前	`"DATABASE"`

オプションパラメータ

名前	型	説明	例
addon_service	文字列	このアドオンサービスの一意の名前	`"heroku-postgresql"`
app	文字列	アプリの名前パターン: `^[a-z][a-z0-9-]{1,28}[a-z0-9]$`	`"example"`

curl の例

$ curl -n -X POST https://api.heroku.com/actions/addon-attachments/resolve \
  -d '{
  "addon_attachment": "DATABASE",
  "app": "example",
  "addon_service": "heroku-postgresql"
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "addon": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "acme-inc-primary-database",
      "app": {
        "id": "01234567-89ab-cdef-0123-456789abcdef",
        "name": "example"
      }
    },
    "app": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "example"
    },
    "created_at": "2012-01-01T12:00:00Z",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "DATABASE",
    "namespace": "role:analytics",
    "updated_at": "2012-01-01T12:00:00Z",
    "web_url": "https://postgres.heroku.com/databases/01234567-89ab-cdef-0123-456789abcdef",
    "log_input_url": "https://token:t.abcdef12-3456-7890-abcd-ef1234567890@1.us.logplex.io/logs"
  }
]

アドオン設定

安定性: 開発

アドオンの設定

属性

名前	型	説明	例
name	文字列	設定の一意の名前	`"FOO"`
value	null 許容文字列	設定の値	`"bar"`

アドオン設定の一覧

アドオンの設定を取得します。アクセス権がある顧客と、このアドオンを提供しているアドオンパートナーがアクセスできます。

Range ヘッダーの唯一の容認可能な順序の値は name です。

GET /addons/{add_on_id_or_name}/config

curl の例

$ curl -n https://api.heroku.com/addons/$ADD_ON_ID_OR_NAME/config \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: name
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "name": "FOO",
    "value": "bar"
  }
]

アドオン設定の更新

アドオンの設定を更新します。このアドオンを提供しているアドオンパートナーだけがアクセスできます。

PATCH /addons/{add_on_id_or_name}/config

オプションパラメータ

名前	型	説明	例
config	配列		`[{"name":"FOO","value":"bar"}]`

curl の例

$ curl -n -X PATCH https://api.heroku.com/addons/$ADD_ON_ID_OR_NAME/config \
  -d '{
  "config": [
    {
      "name": "FOO",
      "value": "bar"
    }
  ]
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "name": "FOO",
    "value": "bar"
  }
]

アドオンプランアクション

安定性: 開発

アドオンプランアクションは、特定のアドオンのインストールのためのプロバイダー機能です。

属性

名前	型	説明	例
action	文字列	SSO 経由で送信される実行すべきアクションの識別子	`"example"`
id	UUID	一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
label	文字列	Dashboard に表示される表示テキスト	`"Example"`
requires_owner	ブール値	アクションにユーザーがアプリを所有していることが必要かどうか	`true`
url	文字列	アクションの代わりに使用する絶対 URL	`"http://example.com?resource_id=:resource_id"`

アドオンリージョン機能

安定性: 本番環境

アドオンリージョン機能は、アドオンサービスと特定のリージョンの間の関係を表します。これらのエンドポイントでは、ベータおよび GA アドオンのみが返されます。

属性

名前	型	説明	例
addon_service:cli_plugin_name	null 許容文字列	アドオンサービスの Heroku CLI プラグインの npm パッケージ名	`"heroku-papertrail"`
addon_service:created_at	日時	アドオンサービスが作成された日時	`"2012-01-01T12:00:00Z"`
addon_service:human_name	文字列	アドオンサービスプロバイダーの人間に解読可能な名前	`"Heroku Postgres"`
addon_service:id	UUID	このアドオンサービスの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
addon_service:name	文字列	このアドオンサービスの一意の名前	`"heroku-postgresql"`
addon_service:state	文字列	アドオンサービスのリリースステータス次のうちのいずれか: `"alpha"`、`"beta"`、`"ga"`、`"shutdown"`	`"ga"`
addon_service:supported_generations/id	UUID	世代の一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
addon_service:supported_generations/name	文字列	世代の一意の名前	`"cedar"`
addon_service:supports_multiple_installations	ブール値	アプリがこのアドオンの複数のインスタンスに同時にアクセスできるかどうか	`false`
addon_service:supports_sharing	ブール値	アプリが別のアプリに請求されているアドオンにアクセスできるかどうか	`false`
addon_service:updated_at	日時	アドオンサービスが更新された日時	`"2012-01-01T12:00:00Z"`
id	UUID	このアドオンリージョン機能の一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
region:country	文字列	リージョンが存在する国	`"United States"`
region:created_at	日時	リージョンが作成された日時	`"2012-01-01T12:00:00Z"`
region:description	文字列	リージョンの説明	`"United States"`
region:id	UUID	リージョンの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
region:locale	文字列	リージョンが存在する国の中の領域	`"Virginia"`
region:name	文字列	リージョンの一意の名前	`"us"`
region:private_capable	ブール値	リージョンが Private Space を作成するために使用できるかどうか	`false`
region:provider:name	文字列	プロバイダーの名前	`"amazon-web-services"`
region:provider:region	文字列	プロバイダーによって使用されるリージョン名次のうちのいずれか: `"ap-south-1"`、`"eu-west-1"`、`"ap-southeast-1"`、`"ap-southeast-2"`、`"eu-central-1"`、`"eu-west-2"`、`"ap-northeast-2"`、`"ap-northeast-1"`、`"us-east-1"`、`"sa-east-1"`、`"us-west-1"`、`"us-west-2"`、`"ca-central-1"`	`"us-east-1"`
region:updated_at	日時	リージョンが更新された日時	`"2012-01-01T12:00:00Z"`
supports_private_networking	ブール値	アドオンを Space にインストールできるかどうか	`true`

アドオンリージョン機能の一覧

すべての既存のアドオンリージョン機能を一覧表示します。

Range ヘッダーの唯一の容認可能な順序の値は id です。

GET /addon-region-capabilities

curl の例

$ curl -n https://api.heroku.com/addon-region-capabilities \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: id
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "supports_private_networking": true,
    "addon_service": {
      "cli_plugin_name": "heroku-papertrail",
      "created_at": "2012-01-01T12:00:00Z",
      "human_name": "Heroku Postgres",
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "heroku-postgresql",
      "state": "ga",
      "supports_multiple_installations": false,
      "supports_sharing": false,
      "updated_at": "2012-01-01T12:00:00Z",
      "supported_generations": [
        {
          "name": "cedar",
          "id": "01234567-89ab-cdef-0123-456789abcdef"
        }
      ]
    },
    "region": {
      "country": "United States",
      "created_at": "2012-01-01T12:00:00Z",
      "description": "United States",
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "locale": "Virginia",
      "name": "us",
      "private_capable": false,
      "provider": {
        "name": "amazon-web-services",
        "region": "us-east-1"
      },
      "updated_at": "2012-01-01T12:00:00Z"
    }
  }
]

アドオンサービスごとのアドオンリージョン機能の一覧

アドオンサービスの既存のアドオンリージョン機能を一覧表示します。

Range ヘッダーの唯一の容認可能な順序の値は id です。

GET /addon-services/{add_on_service_id_or_name}/region-capabilities

curl の例

$ curl -n https://api.heroku.com/addon-services/$ADD_ON_SERVICE_ID_OR_NAME/region-capabilities \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: id
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "supports_private_networking": true,
    "addon_service": {
      "cli_plugin_name": "heroku-papertrail",
      "created_at": "2012-01-01T12:00:00Z",
      "human_name": "Heroku Postgres",
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "heroku-postgresql",
      "state": "ga",
      "supports_multiple_installations": false,
      "supports_sharing": false,
      "updated_at": "2012-01-01T12:00:00Z",
      "supported_generations": [
        {
          "name": "cedar",
          "id": "01234567-89ab-cdef-0123-456789abcdef"
        }
      ]
    },
    "region": {
      "country": "United States",
      "created_at": "2012-01-01T12:00:00Z",
      "description": "United States",
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "locale": "Virginia",
      "name": "us",
      "private_capable": false,
      "provider": {
        "name": "amazon-web-services",
        "region": "us-east-1"
      },
      "updated_at": "2012-01-01T12:00:00Z"
    }
  }
]

リージョンごとのアドオンリージョン機能の一覧

リージョンの既存のアドオンリージョン機能を一覧表示します。

Range ヘッダーの唯一の容認可能な順序の値は id です。

GET /regions/{region_id_or_name}/addon-region-capabilities

curl の例

$ curl -n https://api.heroku.com/regions/$REGION_ID_OR_NAME/addon-region-capabilities \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: id
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "supports_private_networking": true,
    "addon_service": {
      "cli_plugin_name": "heroku-papertrail",
      "created_at": "2012-01-01T12:00:00Z",
      "human_name": "Heroku Postgres",
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "heroku-postgresql",
      "state": "ga",
      "supports_multiple_installations": false,
      "supports_sharing": false,
      "updated_at": "2012-01-01T12:00:00Z",
      "supported_generations": [
        {
          "name": "cedar",
          "id": "01234567-89ab-cdef-0123-456789abcdef"
        }
      ]
    },
    "region": {
      "country": "United States",
      "created_at": "2012-01-01T12:00:00Z",
      "description": "United States",
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "locale": "Virginia",
      "name": "us",
      "private_capable": false,
      "provider": {
        "name": "amazon-web-services",
        "region": "us-east-1"
      },
      "updated_at": "2012-01-01T12:00:00Z"
    }
  }
]

アドオンサービス

安定性: 本番環境

アドオンサービスは、アプリにプロビジョニングできるアドオンを表します。アドオンサービスの下のエンドポイントには認証なしでアクセスできます。

属性

名前	型	説明	例
cli_plugin_name	null 許容文字列	アドオンサービスの Heroku CLI プラグインの npm パッケージ名	`"heroku-papertrail"`
created_at	日時	アドオンサービスが作成された日時	`"2012-01-01T12:00:00Z"`
human_name	文字列	アドオンサービスプロバイダーの人間に解読可能な名前	`"Heroku Postgres"`
id	UUID	このアドオンサービスの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
name	文字列	このアドオンサービスの一意の名前	`"heroku-postgresql"`
state	文字列	アドオンサービスのリリースステータス次のうちのいずれか: `"alpha"`、`"beta"`、`"ga"`、`"shutdown"`	`"ga"`
supported_generations/id	UUID	世代の一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
supported_generations/name	文字列	世代の一意の名前	`"cedar"`
supports_multiple_installations	ブール値	アプリがこのアドオンの複数のインスタンスに同時にアクセスできるかどうか	`false`
supports_sharing	ブール値	アプリが別のアプリに請求されているアドオンにアクセスできるかどうか	`false`
updated_at	日時	アドオンサービスが更新された日時	`"2012-01-01T12:00:00Z"`

アドオンサービスの情報

既存のアドオンサービスに関する情報。

GET /addon-services/{add_on_service_id_or_name}

curl の例

$ curl -n https://api.heroku.com/addon-services/$ADD_ON_SERVICE_ID_OR_NAME \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "cli_plugin_name": "heroku-papertrail",
  "created_at": "2012-01-01T12:00:00Z",
  "human_name": "Heroku Postgres",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "name": "heroku-postgresql",
  "state": "ga",
  "supports_multiple_installations": false,
  "supports_sharing": false,
  "updated_at": "2012-01-01T12:00:00Z",
  "supported_generations": [
    {
      "name": "cedar",
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    }
  ]
}

アドオンサービスの一覧

既存のアドオンサービスを一覧表示します。

Range ヘッダーの容認可能な順序の値は id または name です。

GET /addon-services

curl の例

$ curl -n https://api.heroku.com/addon-services \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: id, name
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "cli_plugin_name": "heroku-papertrail",
    "created_at": "2012-01-01T12:00:00Z",
    "human_name": "Heroku Postgres",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "heroku-postgresql",
    "state": "ga",
    "supports_multiple_installations": false,
    "supports_sharing": false,
    "updated_at": "2012-01-01T12:00:00Z",
    "supported_generations": [
      {
        "name": "cedar",
        "id": "01234567-89ab-cdef-0123-456789abcdef"
      }
    ]
  }
]

アドオン Webhook

安定性: 本番環境

Webhook サブスクリプションの詳細を表します。

属性

名前	型	説明	例
created_at	日時	Webhook が作成された日時	`"2015-01-01T12:00:00Z"`
id	UUID	Webhook の一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
include	配列	サブスクリプションが通知を提供するエンティティ	`["api:release"]`
level	文字列	`notify` の場合、Heroku は 1 つのファイアアンドフォーゲット配信を試行します。`sync`の場合、Heroku はリクエストが成功するか、または制限に達するまで複数の配信を試行します。次のうちのいずれか: `"notify"`、`"sync"`	`"notify"`
updated_at	日時	Webhook が更新された日時	`"2015-01-01T12:00:00Z"`
url	URI	Webhook の通知リクエストが送信される URL

アドオン Webhook の作成

アドオン Webhook サブスクリプションを作成します。このアドオンを提供しているアドオンパートナーだけがアクセスできます。

POST /addons/{add_on_id_or_name}/webhooks

必須パラメータ

名前	型	説明	例
include	配列	サブスクリプションが通知を提供するエンティティ	`["api:release"]`
level	文字列	`notify` の場合、Heroku は 1 つのファイアアンドフォーゲット配信を試行します。`sync`の場合、Heroku はリクエストが成功するか、または制限に達するまで複数の配信を試行します。次のうちのいずれか: `"notify"`、`"sync"`	`"notify"`
url	URI	Webhook の通知リクエストが送信される URL

オプションパラメータ

名前	型	説明	例
authorization	null 許容文字列	Heroku がすべての Webhook 通知に含めるカスタム `Authorization` ヘッダー	`"Bearer 9266671b2767f804c9d5809c2d384ed57d8f8ce1abd1043e1fb3fbbcb8c3"`
secret	null 許容文字列	Heroku がすべての Webhook 通知リクエストに署名するために使用する値 (この署名はリクエストの `Heroku-Webhook-Hmac-SHA256` ヘッダーに含まれる)	`"dcbff0c4430a2960a2552389d587bc58d30a37a8cf3f75f8fb77abe667ad"`

curl の例

$ curl -n -X POST https://api.heroku.com/addons/$ADD_ON_ID_OR_NAME/webhooks \
  -d '{
  "authorization": "Bearer 9266671b2767f804c9d5809c2d384ed57d8f8ce1abd1043e1fb3fbbcb8c3",
  "include": [
    "api:release"
  ],
  "level": "notify",
  "secret": "dcbff0c4430a2960a2552389d587bc58d30a37a8cf3f75f8fb77abe667ad",
  "url": "example"
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 201 Created
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "addon": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "acme-inc-primary-database"
  },
  "created_at": "2015-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "include": [
    "api:release"
  ],
  "level": "notify",
  "updated_at": "2015-01-01T12:00:00Z",
  "url": "example"
}

アドオン Webhook の削除

アドオン Webhook サブスクリプションを削除します。このアドオンを提供しているアドオンパートナーだけがアクセスできます。

DELETE /addons/{add_on_id_or_name}/webhooks/{app_webhook_id}

curl の例

$ curl -n -X DELETE https://api.heroku.com/addons/$ADD_ON_ID_OR_NAME/webhooks/$APP_WEBHOOK_ID \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "addon": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "acme-inc-primary-database"
  },
  "created_at": "2015-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "include": [
    "api:release"
  ],
  "level": "notify",
  "updated_at": "2015-01-01T12:00:00Z",
  "url": "example"
}

アドオン Webhook の情報

アドオン Webhook サブスクリプションに関する情報を返します。このアドオンを提供しているアドオンパートナーだけがアクセスできます。

GET /addons/{add_on_id_or_name}/webhooks/{app_webhook_id}

curl の例

$ curl -n https://api.heroku.com/addons/$ADD_ON_ID_OR_NAME/webhooks/$APP_WEBHOOK_ID \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "addon": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "acme-inc-primary-database"
  },
  "created_at": "2015-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "include": [
    "api:release"
  ],
  "level": "notify",
  "updated_at": "2015-01-01T12:00:00Z",
  "url": "example"
}

アドオン Webhook の一覧

特定のアドオンのすべての Webhook サブスクリプションを一覧表示します。このアドオンを提供しているアドオンパートナーだけがアクセスできます。

GET /addons/{add_on_id_or_name}/webhooks

curl の例

$ curl -n https://api.heroku.com/addons/$ADD_ON_ID_OR_NAME/webhooks \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "addon": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "acme-inc-primary-database"
    },
    "created_at": "2015-01-01T12:00:00Z",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "include": [
      "api:release"
    ],
    "level": "notify",
    "updated_at": "2015-01-01T12:00:00Z",
    "url": "example"
  }
]

アドオン Webhook の更新

アドオン Webhook サブスクリプションの詳細を更新します。このアドオンを提供しているアドオンパートナーだけがアクセスできます。

PATCH /addons/{add_on_id_or_name}/webhooks/{app_webhook_id}

オプションパラメータ

名前	型	説明	例
authorization	null 許容文字列	Heroku がすべての Webhook 通知に含めるカスタム `Authorization` ヘッダー	`"Bearer 9266671b2767f804c9d5809c2d384ed57d8f8ce1abd1043e1fb3fbbcb8c3"`
include	配列	サブスクリプションが通知を提供するエンティティ	`["api:release"]`
level	文字列	`notify` の場合、Heroku は 1 つのファイアアンドフォーゲット配信を試行します。`sync`の場合、Heroku はリクエストが成功するか、または制限に達するまで複数の配信を試行します。次のうちのいずれか: `"notify"`、`"sync"`	`"notify"`
secret	null 許容文字列	Heroku がすべての Webhook 通知リクエストに署名するために使用する値 (この署名はリクエストの `Heroku-Webhook-Hmac-SHA256` ヘッダーに含まれる)	`"dcbff0c4430a2960a2552389d587bc58d30a37a8cf3f75f8fb77abe667ad"`
url	URI	Webhook の通知リクエストが送信される URL

curl の例

$ curl -n -X PATCH https://api.heroku.com/addons/$ADD_ON_ID_OR_NAME/webhooks/$APP_WEBHOOK_ID \
  -d '{
  "authorization": "Bearer 9266671b2767f804c9d5809c2d384ed57d8f8ce1abd1043e1fb3fbbcb8c3",
  "include": [
    "api:release"
  ],
  "level": "notify",
  "secret": "dcbff0c4430a2960a2552389d587bc58d30a37a8cf3f75f8fb77abe667ad",
  "url": "example"
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "addon": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "acme-inc-primary-database"
  },
  "created_at": "2015-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "include": [
    "api:release"
  ],
  "level": "notify",
  "updated_at": "2015-01-01T12:00:00Z",
  "url": "example"
}

アドオン Webhook 配信

安定性: 本番環境

Webhook 通知 (その現在のステータスを含む) の配信を表します。

アドオン Webhook 配信の情報

既存の配信に関する情報を返します。このアドオンを提供しているアドオンパートナーだけがアクセスできます。

GET /addons/{add_on_id_or_name}/webhook-deliveries/{app_webhook_delivery_id}

curl の例

$ curl -n https://api.heroku.com/addons/$ADD_ON_ID_OR_NAME/webhook-deliveries/$APP_WEBHOOK_DELIVERY_ID \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "created_at": "2015-01-01T12:00:00Z",
  "event": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "include": "api:release"
  },
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "num_attempts": 42,
  "next_attempt_at": "2015-01-01T12:00:00Z",
  "last_attempt": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "code": 42,
    "error_class": "example",
    "status": "scheduled",
    "created_at": "2015-01-01T12:00:00Z",
    "updated_at": "2015-01-01T12:00:00Z"
  },
  "status": "pending",
  "updated_at": "2015-01-01T12:00:00Z",
  "webhook": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "level": "notify"
  }
}

アドオン Webhook 配信の一覧

アドオンの既存の配信を一覧表示します。このアドオンを提供しているアドオンパートナーだけがアクセスできます。

GET /addons/{add_on_id_or_name}/webhook-deliveries

curl の例

$ curl -n https://api.heroku.com/addons/$ADD_ON_ID_OR_NAME/webhook-deliveries \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "created_at": "2015-01-01T12:00:00Z",
    "event": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "include": "api:release"
    },
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "num_attempts": 42,
    "next_attempt_at": "2015-01-01T12:00:00Z",
    "last_attempt": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "code": 42,
      "error_class": "example",
      "status": "scheduled",
      "created_at": "2015-01-01T12:00:00Z",
      "updated_at": "2015-01-01T12:00:00Z"
    },
    "status": "pending",
    "updated_at": "2015-01-01T12:00:00Z",
    "webhook": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "level": "notify"
    }
  }
]

アドオン Webhook イベント

安定性: 本番環境

発生した Webhook イベントを表します。

アドオン Webhook イベントの情報

指定された Webhook イベントに関する情報を返します。このアドオンを提供しているアドオンパートナーだけがアクセスできます。

GET /addons/{add_on_id_or_name}/webhook-events/{app_webhook_event_id}

curl の例

$ curl -n https://api.heroku.com/addons/$ADD_ON_ID_OR_NAME/webhook-events/$APP_WEBHOOK_EVENT_ID \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "created_at": "2015-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "include": "api:release",
  "payload": {
    "action": "create",
    "actor": {
      "email": "username@example.com",
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    },
    "data": null,
    "previous_data": null,
    "resource": "release",
    "version": "1"
  },
  "updated_at": "2015-01-01T12:00:00Z"
}

アドオン Webhook イベントの一覧

アドオンの既存の Webhook イベントを一覧表示します。このアドオンを提供しているアドオンパートナーだけがアクセスできます。

GET /addons/{add_on_id_or_name}/webhook-events

curl の例

$ curl -n https://api.heroku.com/addons/$ADD_ON_ID_OR_NAME/webhook-events \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "created_at": "2015-01-01T12:00:00Z",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "include": "api:release",
    "payload": {
      "action": "create",
      "actor": {
        "email": "username@example.com",
        "id": "01234567-89ab-cdef-0123-456789abcdef"
      },
      "data": null,
      "previous_data": null,
      "resource": "release",
      "version": "1"
    },
    "updated_at": "2015-01-01T12:00:00Z"
  }
]

許可されたアドオンサービス

安定性: プロトタイプ

チームで使用することを許可されたエンティティ

属性

名前	型	説明	例
added_at	日時	アドオンサービスが許可された日時	`"2012-01-01T12:00:00Z"`
added_by:email	null 許容メール	アカウントの一意のメールアドレス	`"username@example.com"`
added_by:id	null 許容 UUID	アカウントの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
addon_service:human_name	文字列	アドオンサービスプロバイダーの人間に解読可能な名前	`"Heroku Postgres"`
addon_service:id	UUID	このアドオンサービスの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
addon_service:name	文字列	このアドオンサービスの一意の名前	`"heroku-postgresql"`
id	UUID	この許可されたアドオンサービスレコードの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`

チームごとの許可されたアドオンサービスの一覧

チームのすべての許可されたアドオンサービスを一覧表示します。

Range ヘッダーの容認可能な順序の値は id または name です。

GET /teams/{team_name_or_id}/allowed-addon-services

curl の例

$ curl -n https://api.heroku.com/teams/$TEAM_NAME_OR_ID/allowed-addon-services \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: id, name
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "added_at": "2012-01-01T12:00:00Z",
    "added_by": {
      "email": "username@example.com",
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    },
    "addon_service": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "heroku-postgresql",
      "human_name": "Heroku Postgres"
    },
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  }
]

チームごとの許可されたアドオンサービスの作成

アドオンサービスを許可します。

POST /teams/{team_name_or_id}/allowed-addon-services

オプションパラメータ

名前	型	説明	例
addon_service	文字列	許可するアドオンサービスの名前	`"heroku-postgresql"`

curl の例

$ curl -n -X POST https://api.heroku.com/teams/$TEAM_NAME_OR_ID/allowed-addon-services \
  -d '{
  "addon_service": "heroku-postgresql"
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 201 Created
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "added_at": "2012-01-01T12:00:00Z",
    "added_by": {
      "email": "username@example.com",
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    },
    "addon_service": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "heroku-postgresql",
      "human_name": "Heroku Postgres"
    },
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  }
]

チームごとの許可されたアドオンサービスの削除

許可されたアドオンサービスを削除します。

DELETE /teams/{team_name_or_id}/allowed-addon-services/{allowed_add_on_service_id_or_name}

curl の例

$ curl -n -X DELETE https://api.heroku.com/teams/$TEAM_NAME_OR_ID/allowed-addon-services/$ALLOWED_ADD_ON_SERVICE_ID_OR_NAME \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "added_at": "2012-01-01T12:00:00Z",
  "added_by": {
    "email": "username@example.com",
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "addon_service": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "heroku-postgresql",
    "human_name": "Heroku Postgres"
  },
  "id": "01234567-89ab-cdef-0123-456789abcdef"
}

アプリ

安定性: 本番環境

アプリは、Heroku にデプロイして実行するプログラムを表します。

属性

名前	型	説明	例
acm	ブール値	このアプリの ACM ステータス	`false`
archived_at	null 許容日時	アプリがアーカイブされた日時	`"2012-01-01T12:00:00Z"`
build_stack:id	UUID	スタックの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
build_stack:name	文字列	スタックの一意の名前	`"heroku-18"`
buildpack_provided_description	null 許容文字列	アプリの buildpack からの説明	`"Ruby/Rack"`
created_at	日時	アプリが作成された日時	`"2012-01-01T12:00:00Z"`
generation:id	UUID	このアプリの Heroku プラットフォームの世代の一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
generation:name	文字列	このアプリの Heroku プラットフォームの世代の一意の名前	`"cedar"`
git_url	文字列	アプリの Git リポジトリ URL パターン: `^https://git.heroku.com/[a-z][a-z0-9-]{2,29}.git$`	`"https://git.heroku.com/example.git"`
id	UUID	一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
internal_routing	null 許容ブール値	Private Spaces アプリが外部にルーティング可能かどうかの説明	`false`
maintenance	ブール値	アプリのメンテナンスステータス	`false`
name	文字列	アプリの名前パターン: `^[a-z][a-z0-9-]{1,28}[a-z0-9]$`	`"example"`
organization	null 許容オブジェクト	チームの ID	`null`
organization:id	UUID	チームの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
organization:name	文字列	チームの一意の名前	`"example"`
owner:email	メール	アカウントの一意のメールアドレス	`"username@example.com"`
owner:id	UUID	アカウントの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
region:id	UUID	リージョンの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
region:name	文字列	リージョンの一意の名前	`"us"`
released_at	null 許容日時	アプリがリリースされた日時	`"2012-01-01T12:00:00Z"`
repo_size	null 許容整数	アプリの Git リポジトリのサイズ (バイト単位)	`0`
slug_size	null 許容整数	アプリの slug のサイズ (バイト単位)	`0`
space	null 許容オブジェクト	Space の ID	`null`
space:id	UUID	Space の一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
space:name	文字列	Space の一意の名前パターン: `^[a-z0-9](?:[a-z0-9]\|-(?!-))+[a-z0-9]$`	`"nasa"`
space:shield	ブール値	この Space で Shield が有効になっている場合は true	`true`
stack:id	UUID	スタックの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
stack:name	文字列	スタックの一意の名前	`"heroku-18"`
team	null 許容オブジェクト	チームの ID	`null`
team:id	UUID	チームの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
team:name	文字列	チームの一意の名前	`"example"`
updated_at	日時	アプリが更新された日時	`"2012-01-01T12:00:00Z"`
web_url	null 許容 URI	アプリの Web URL パターン: `^https?://[a-z][a-z0-9-]{3,43}.herokuapp.com/$`	`"https://example.herokuapp.com/"`

アプリの作成

新しいアプリを作成します。

POST /apps

オプションパラメータ

名前	型	説明	例
feature_flags	配列	アプリ機能の一意の名前	`["name"]`
name	文字列	アプリの名前パターン: `^[a-z][a-z0-9-]{1,28}[a-z0-9]$`	`"example"`
region	文字列	リージョンの一意識別子または名前	`"01234567-89ab-cdef-0123-456789abcdef"` または `"us"`
stack	文字列	スタックの一意の名前または識別子	`"heroku-18"` または `"01234567-89ab-cdef-0123-456789abcdef"`

curl の例

$ curl -n -X POST https://api.heroku.com/apps \
  -d '{
  "name": "example",
  "region": "01234567-89ab-cdef-0123-456789abcdef",
  "stack": "01234567-89ab-cdef-0123-456789abcdef",
  "feature_flags": [
    "name"
  ]
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 201 Created
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "acm": false,
  "archived_at": "2012-01-01T12:00:00Z",
  "buildpack_provided_description": "Ruby/Rack",
  "build_stack": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "heroku-18"
  },
  "created_at": "2012-01-01T12:00:00Z",
  "generation": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "cedar"
  },
  "git_url": "https://git.heroku.com/example.git",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "internal_routing": false,
  "maintenance": false,
  "name": "example",
  "owner": {
    "email": "username@example.com",
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "organization": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  },
  "team": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  },
  "region": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "us"
  },
  "released_at": "2012-01-01T12:00:00Z",
  "repo_size": 0,
  "slug_size": 0,
  "space": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "nasa",
    "shield": true
  },
  "stack": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "heroku-18"
  },
  "updated_at": "2012-01-01T12:00:00Z",
  "web_url": "https://example.herokuapp.com/"
}

アプリの削除

既存のアプリを削除します。

DELETE /apps/{app_id_or_name}

curl の例

$ curl -n -X DELETE https://api.heroku.com/apps/$APP_ID_OR_NAME \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "acm": false,
  "archived_at": "2012-01-01T12:00:00Z",
  "buildpack_provided_description": "Ruby/Rack",
  "build_stack": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "heroku-18"
  },
  "created_at": "2012-01-01T12:00:00Z",
  "generation": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "cedar"
  },
  "git_url": "https://git.heroku.com/example.git",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "internal_routing": false,
  "maintenance": false,
  "name": "example",
  "owner": {
    "email": "username@example.com",
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "organization": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  },
  "team": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  },
  "region": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "us"
  },
  "released_at": "2012-01-01T12:00:00Z",
  "repo_size": 0,
  "slug_size": 0,
  "space": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "nasa",
    "shield": true
  },
  "stack": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "heroku-18"
  },
  "updated_at": "2012-01-01T12:00:00Z",
  "web_url": "https://example.herokuapp.com/"
}

アプリの情報

既存のアプリに関する情報。

GET /apps/{app_id_or_name}

curl の例

$ curl -n https://api.heroku.com/apps/$APP_ID_OR_NAME \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "acm": false,
  "archived_at": "2012-01-01T12:00:00Z",
  "buildpack_provided_description": "Ruby/Rack",
  "build_stack": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "heroku-18"
  },
  "created_at": "2012-01-01T12:00:00Z",
  "generation": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "cedar"
  },
  "git_url": "https://git.heroku.com/example.git",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "internal_routing": false,
  "maintenance": false,
  "name": "example",
  "owner": {
    "email": "username@example.com",
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "organization": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  },
  "team": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  },
  "region": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "us"
  },
  "released_at": "2012-01-01T12:00:00Z",
  "repo_size": 0,
  "slug_size": 0,
  "space": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "nasa",
    "shield": true
  },
  "stack": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "heroku-18"
  },
  "updated_at": "2012-01-01T12:00:00Z",
  "web_url": "https://example.herokuapp.com/"
}

アプリの一覧

既存のアプリを一覧表示します。

Range ヘッダーの容認可能な順序の値は id、name または updated_at です。

GET /apps

curl の例

$ curl -n https://api.heroku.com/apps \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: id, name, updated_at
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "acm": false,
    "archived_at": "2012-01-01T12:00:00Z",
    "buildpack_provided_description": "Ruby/Rack",
    "build_stack": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "heroku-18"
    },
    "created_at": "2012-01-01T12:00:00Z",
    "generation": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "cedar"
    },
    "git_url": "https://git.heroku.com/example.git",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "internal_routing": false,
    "maintenance": false,
    "name": "example",
    "owner": {
      "email": "username@example.com",
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    },
    "organization": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "example"
    },
    "team": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "example"
    },
    "region": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "us"
    },
    "released_at": "2012-01-01T12:00:00Z",
    "repo_size": 0,
    "slug_size": 0,
    "space": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "nasa",
      "shield": true
    },
    "stack": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "heroku-18"
    },
    "updated_at": "2012-01-01T12:00:00Z",
    "web_url": "https://example.herokuapp.com/"
  }
]

所有および共同作業されるアプリの一覧

所有および共同作業されるアプリを一覧表示します (チームアプリを除く)。

Range ヘッダーの容認可能な順序の値は id、name または updated_at です。

GET /users/{account_email_or_id_or_self}/apps

curl の例

$ curl -n https://api.heroku.com/users/$ACCOUNT_EMAIL_OR_ID_OR_SELF/apps \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: id, name, updated_at
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "acm": false,
    "archived_at": "2012-01-01T12:00:00Z",
    "buildpack_provided_description": "Ruby/Rack",
    "build_stack": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "heroku-18"
    },
    "created_at": "2012-01-01T12:00:00Z",
    "generation": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "cedar"
    },
    "git_url": "https://git.heroku.com/example.git",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "internal_routing": false,
    "maintenance": false,
    "name": "example",
    "owner": {
      "email": "username@example.com",
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    },
    "organization": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "example"
    },
    "team": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "example"
    },
    "region": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "us"
    },
    "released_at": "2012-01-01T12:00:00Z",
    "repo_size": 0,
    "slug_size": 0,
    "space": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "nasa",
      "shield": true
    },
    "stack": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "heroku-18"
    },
    "updated_at": "2012-01-01T12:00:00Z",
    "web_url": "https://example.herokuapp.com/"
  }
]

アプリの更新

既存のアプリを更新します。

PATCH /apps/{app_id_or_name}

オプションパラメータ

名前	型	説明	例
build_stack	文字列	スタックの一意の名前または識別子	`"heroku-18"` または `"01234567-89ab-cdef-0123-456789abcdef"`
maintenance	ブール値	アプリのメンテナンスステータス	`false`
name	文字列	アプリの名前パターン: `^[a-z][a-z0-9-]{1,28}[a-z0-9]$`	`"example"`

curl の例

$ curl -n -X PATCH https://api.heroku.com/apps/$APP_ID_OR_NAME \
  -d '{
  "build_stack": "01234567-89ab-cdef-0123-456789abcdef",
  "maintenance": false,
  "name": "example"
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "acm": false,
  "archived_at": "2012-01-01T12:00:00Z",
  "buildpack_provided_description": "Ruby/Rack",
  "build_stack": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "heroku-18"
  },
  "created_at": "2012-01-01T12:00:00Z",
  "generation": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "cedar"
  },
  "git_url": "https://git.heroku.com/example.git",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "internal_routing": false,
  "maintenance": false,
  "name": "example",
  "owner": {
    "email": "username@example.com",
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "organization": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  },
  "team": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  },
  "region": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "us"
  },
  "released_at": "2012-01-01T12:00:00Z",
  "repo_size": 0,
  "slug_size": 0,
  "space": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "nasa",
    "shield": true
  },
  "stack": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "heroku-18"
  },
  "updated_at": "2012-01-01T12:00:00Z",
  "web_url": "https://example.herokuapp.com/"
}

アプリの ACM の有効化

アプリの ACM フラグを有効にします。

POST /apps/{app_id_or_name}/acm

curl の例

$ curl -n -X POST https://api.heroku.com/apps/$APP_ID_OR_NAME/acm \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "acm": false,
  "archived_at": "2012-01-01T12:00:00Z",
  "buildpack_provided_description": "Ruby/Rack",
  "build_stack": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "heroku-18"
  },
  "created_at": "2012-01-01T12:00:00Z",
  "generation": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "cedar"
  },
  "git_url": "https://git.heroku.com/example.git",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "internal_routing": false,
  "maintenance": false,
  "name": "example",
  "owner": {
    "email": "username@example.com",
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "organization": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  },
  "team": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  },
  "region": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "us"
  },
  "released_at": "2012-01-01T12:00:00Z",
  "repo_size": 0,
  "slug_size": 0,
  "space": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "nasa",
    "shield": true
  },
  "stack": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "heroku-18"
  },
  "updated_at": "2012-01-01T12:00:00Z",
  "web_url": "https://example.herokuapp.com/"
}

アプリの ACM の無効化

アプリの ACM フラグを無効にします。

DELETE /apps/{app_id_or_name}/acm

curl の例

$ curl -n -X DELETE https://api.heroku.com/apps/$APP_ID_OR_NAME/acm \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "acm": false,
  "archived_at": "2012-01-01T12:00:00Z",
  "buildpack_provided_description": "Ruby/Rack",
  "build_stack": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "heroku-18"
  },
  "created_at": "2012-01-01T12:00:00Z",
  "generation": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "cedar"
  },
  "git_url": "https://git.heroku.com/example.git",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "internal_routing": false,
  "maintenance": false,
  "name": "example",
  "owner": {
    "email": "username@example.com",
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "organization": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  },
  "team": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  },
  "region": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "us"
  },
  "released_at": "2012-01-01T12:00:00Z",
  "repo_size": 0,
  "slug_size": 0,
  "space": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "nasa",
    "shield": true
  },
  "stack": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "heroku-18"
  },
  "updated_at": "2012-01-01T12:00:00Z",
  "web_url": "https://example.herokuapp.com/"
}

アプリの ACM の更新

アプリの ACM を更新します。

PATCH /apps/{app_id_or_name}/acm

curl の例

$ curl -n -X PATCH https://api.heroku.com/apps/$APP_ID_OR_NAME/acm \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "acm": false,
  "archived_at": "2012-01-01T12:00:00Z",
  "buildpack_provided_description": "Ruby/Rack",
  "build_stack": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "heroku-18"
  },
  "created_at": "2012-01-01T12:00:00Z",
  "generation": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "cedar"
  },
  "git_url": "https://git.heroku.com/example.git",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "internal_routing": false,
  "maintenance": false,
  "name": "example",
  "owner": {
    "email": "username@example.com",
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "organization": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  },
  "team": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  },
  "region": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "us"
  },
  "released_at": "2012-01-01T12:00:00Z",
  "repo_size": 0,
  "slug_size": 0,
  "space": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "nasa",
    "shield": true
  },
  "stack": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "heroku-18"
  },
  "updated_at": "2012-01-01T12:00:00Z",
  "web_url": "https://example.herokuapp.com/"
}

アプリ機能

安定性: 本番環境

アプリ機能は、Heroku 上のアプリに対して有効または無効にできる Heroku Labs 機能を表します。

属性

名前	型	説明	例
created_at	日時	アプリ機能が作成された日時	`"2012-01-01T12:00:00Z"`
description	文字列	アプリ機能の説明	`"Causes app to example."`
display_name	文字列	ユーザーで解読可能な機能名	`"My Feature"`
doc_url	文字列	アプリ機能のドキュメント URL	`"http://devcenter.heroku.com/articles/example"`
enabled	ブール値	アプリ機能が有効になっているかどうか	`true`
feedback_email	文字列	機能に関するフィードバックを送信するためのメール	`"feedback@heroku.com"`
id	UUID	アプリ機能の一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
name	文字列	アプリ機能の一意の名前	`"name"`
state	文字列	アプリ機能の状態	`"public"`
updated_at	日時	アプリ機能が更新された日時	`"2012-01-01T12:00:00Z"`

アプリ機能の情報

既存のアプリ機能に関する情報。

GET /apps/{app_id_or_name}/features/{app_feature_id_or_name}

curl の例

$ curl -n https://api.heroku.com/apps/$APP_ID_OR_NAME/features/$APP_FEATURE_ID_OR_NAME \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "created_at": "2012-01-01T12:00:00Z",
  "description": "Causes app to example.",
  "doc_url": "http://devcenter.heroku.com/articles/example",
  "enabled": true,
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "name": "name",
  "state": "public",
  "updated_at": "2012-01-01T12:00:00Z",
  "display_name": "My Feature",
  "feedback_email": "feedback@heroku.com"
}

アプリ機能の一覧

既存のアプリ機能を一覧表示します。

Range ヘッダーの容認可能な順序の値は id または name です。

GET /apps/{app_id_or_name}/features

curl の例

$ curl -n https://api.heroku.com/apps/$APP_ID_OR_NAME/features \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: id, name
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "created_at": "2012-01-01T12:00:00Z",
    "description": "Causes app to example.",
    "doc_url": "http://devcenter.heroku.com/articles/example",
    "enabled": true,
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "name",
    "state": "public",
    "updated_at": "2012-01-01T12:00:00Z",
    "display_name": "My Feature",
    "feedback_email": "feedback@heroku.com"
  }
]

アプリ機能の更新

既存のアプリ機能を更新します。

PATCH /apps/{app_id_or_name}/features/{app_feature_id_or_name}

必須パラメータ

名前	型	説明	例
enabled	ブール値	アプリ機能が有効になっているかどうか	`true`

curl の例

$ curl -n -X PATCH https://api.heroku.com/apps/$APP_ID_OR_NAME/features/$APP_FEATURE_ID_OR_NAME \
  -d '{
  "enabled": true
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "created_at": "2012-01-01T12:00:00Z",
  "description": "Causes app to example.",
  "doc_url": "http://devcenter.heroku.com/articles/example",
  "enabled": true,
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "name": "name",
  "state": "public",
  "updated_at": "2012-01-01T12:00:00Z",
  "display_name": "My Feature",
  "feedback_email": "feedback@heroku.com"
}

アプリの設定

安定性: 本番環境

アプリの設定は、app.json マニフェストファイルに記述されている環境、アドオン、スクリプトを使用して設定される Heroku 上のアプリを表します。

属性

名前	型	説明	例
app:id	UUID	一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
app:name	文字列	アプリの名前パターン: `^[a-z][a-z0-9-]{1,28}[a-z0-9]$`	`"example"`
build	null 許容オブジェクト	ビルドの ID とステータス	`null`
build:id	UUID	ビルドの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
build:output_stream_url	文字列	ビルドプロセスの出力は、ストリームとしてこの URL から入手できます。このストリームは、`text/plain` または `text/event-stream` のどちらかとして入手できます。クライアントは切断を処理できるよう準備し、`Range` ヘッダー (`text/plain` の場合) または `Last-Event-Id` ヘッダー (`text/event-stream` の場合) を送信することによってストリームを再開できます。	`"https://build-output.heroku.com/streams/01234567-89ab-cdef-0123-456789abcdef"`
build:status	文字列	ビルドのステータス次のうちのいずれか: `"failed"`、`"pending"`、`"succeeded"`	`"succeeded"`
created_at	日時	アプリの設定が作成された日時	`"2012-01-01T12:00:00Z"`
failure_message	null 許容文字列	アプリの設定が失敗した理由	`"invalid app.json"`
id	UUID	アプリの設定の一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
manifest_errors	配列	無効な app.json マニフェストファイルに関連付けられているエラー	`["config var FOO is required"]`
postdeploy	null 許容オブジェクト	postdeploy スクリプトの結果	`null`
postdeploy:exit_code	整数	postdeploy スクリプトの終了コード	`1`
postdeploy:output	文字列	postdeploy スクリプトの出力	`"assets precompiled"`
resolved_success_url	null 許容文字列	完全修飾の成功 URL	`"https://example.herokuapp.com/welcome"`
status	文字列	アプリの設定の全体的なステータス次のうちのいずれか: `"failed"`、`"pending"`、`"succeeded"`	`"failed"`
updated_at	日時	アプリの設定が更新された日時	`"2012-01-01T12:00:00Z"`

アプリの設定の作成

app.json マニフェストファイルを含む gzip で圧縮された tar アーカイブから新しいアプリの設定を作成します。

POST /app-setups

必須パラメータ

名前	型	説明	例
source_blob:checksum	null 許容文字列	その完全性を確認するための gzip で圧縮された tarball のオプションのチェックサム	`"SHA256:e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"`
source_blob:url	文字列	app.json マニフェストファイルを含むソースコードの gzip で圧縮された tarball の URL	`"https://example.com/source.tgz?token=xyz"`
source_blob:version	null 許容文字列	gzip で圧縮された tarball のバージョン	`"v1.3.0"`

オプションパラメータ

名前	型	説明	例
app:locked	ブール値	このアプリへの参加を禁止されているその他のチームメンバーであるかどうか	`false`
app:name	文字列	アプリの名前パターン: `^[a-z][a-z0-9-]{1,28}[a-z0-9]$`	`"example"`
app:organization	文字列	チームの一意の名前	`"example"`
app:personal	ブール値	デフォルトチームが設定されている場合でもユーザーアカウントでアプリを強制的に作成します。	`false`
app:region	文字列	リージョンの名前	`"us"`
app:space	文字列	Space の一意の名前パターン: `^[a-z0-9](?:[a-z0-9]\|-(?!-))+[a-z0-9]$`	`"nasa"`
app:stack	文字列	一意の名前	`"heroku-18"`
overrides:buildpacks	配列	app.json マニフェストファイルで指定されている buildpack の上書き	`[{"url":"https://example.com/buildpack.tgz"}]`
overrides:env	オブジェクト	app.json マニフェストファイルで指定されている ENV の上書き	`{"FOO":"bar","BAZ":"qux"}`

curl の例

$ curl -n -X POST https://api.heroku.com/app-setups \
  -d '{
  "app": {
    "locked": false,
    "name": "example",
    "organization": "example",
    "personal": false,
    "region": "us",
    "space": "nasa",
    "stack": "heroku-18"
  },
  "source_blob": {
    "checksum": "SHA256:e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
    "url": "https://example.com/source.tgz?token=xyz",
    "version": "v1.3.0"
  },
  "overrides": {
    "buildpacks": [
      {
        "url": "https://example.com/buildpack.tgz"
      }
    ],
    "env": {
      "FOO": "bar",
      "BAZ": "qux"
    }
  }
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 201 Created
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "created_at": "2012-01-01T12:00:00Z",
  "updated_at": "2012-01-01T12:00:00Z",
  "status": "failed",
  "failure_message": "invalid app.json",
  "app": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  },
  "build": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "status": "succeeded",
    "output_stream_url": "https://build-output.heroku.com/streams/01234567-89ab-cdef-0123-456789abcdef"
  },
  "manifest_errors": [
    "config var FOO is required"
  ],
  "postdeploy": {
    "output": "assets precompiled",
    "exit_code": 1
  },
  "resolved_success_url": "https://example.herokuapp.com/welcome"
}

アプリの設定の情報

アプリの設定のステータスを取得します。

GET /app-setups/{app_setup_id}

curl の例

$ curl -n https://api.heroku.com/app-setups/$APP_SETUP_ID \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "created_at": "2012-01-01T12:00:00Z",
  "updated_at": "2012-01-01T12:00:00Z",
  "status": "failed",
  "failure_message": "invalid app.json",
  "app": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  },
  "build": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "status": "succeeded",
    "output_stream_url": "https://build-output.heroku.com/streams/01234567-89ab-cdef-0123-456789abcdef"
  },
  "manifest_errors": [
    "config var FOO is required"
  ],
  "postdeploy": {
    "output": "assets precompiled",
    "exit_code": 1
  },
  "resolved_success_url": "https://example.herokuapp.com/welcome"
}

アプリの移動

安定性: 本番環境

アプリの移動は、アプリの所有権を移動するための 2 人の当事者の対話を表します。

属性

名前	型	説明	例
app:id	UUID	一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
app:name	文字列	アプリの名前パターン: `^[a-z][a-z0-9-]{1,28}[a-z0-9]$`	`"example"`
created_at	日時	アプリの移動が作成された日時	`"2012-01-01T12:00:00Z"`
id	UUID	アプリの移動の一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
owner:email	メール	アカウントの一意のメールアドレス	`"username@example.com"`
owner:id	UUID	アカウントの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
recipient:email	メール	アカウントの一意のメールアドレス	`"username@example.com"`
recipient:id	UUID	アカウントの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
state	文字列	アプリの移動の現在の状態次のうちのいずれか: `"pending"`、`"accepted"`、`"declined"`	`"pending"`
updated_at	日時	アプリの移動が更新された日時	`"2012-01-01T12:00:00Z"`

アプリの移動の作成

新しいアプリの移動を作成します。

POST /account/app-transfers

必須パラメータ

名前	型	説明	例
app	文字列	アプリの一意識別子または名前	`"01234567-89ab-cdef-0123-456789abcdef"` または `"example"`
recipient	文字列	一意のメールアドレス、アカウントの識別子、または現在承認されているユーザーへの暗黙的な参照	`"username@example.com"`、`"01234567-89ab-cdef-0123-456789abcdef"`、または `"~"`

オプションパラメータ

名前	型	説明	例
silent	ブール値	アプリの移動時のメール通知を抑制するかどうか	`false`

curl の例

$ curl -n -X POST https://api.heroku.com/account/app-transfers \
  -d '{
  "app": "01234567-89ab-cdef-0123-456789abcdef",
  "recipient": "01234567-89ab-cdef-0123-456789abcdef",
  "silent": false
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 201 Created
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "app": {
    "name": "example",
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "owner": {
    "email": "username@example.com",
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "recipient": {
    "email": "username@example.com",
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "state": "pending",
  "updated_at": "2012-01-01T12:00:00Z"
}

アプリの移動の削除

既存のアプリの移動を削除します。

DELETE /account/app-transfers/{app_transfer_id_or_name}

curl の例

$ curl -n -X DELETE https://api.heroku.com/account/app-transfers/$APP_TRANSFER_ID_OR_NAME \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "app": {
    "name": "example",
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "owner": {
    "email": "username@example.com",
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "recipient": {
    "email": "username@example.com",
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "state": "pending",
  "updated_at": "2012-01-01T12:00:00Z"
}

アプリの移動の情報

既存のアプリの移動に関する情報。

GET /account/app-transfers/{app_transfer_id_or_name}

curl の例

$ curl -n https://api.heroku.com/account/app-transfers/$APP_TRANSFER_ID_OR_NAME \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "app": {
    "name": "example",
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "owner": {
    "email": "username@example.com",
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "recipient": {
    "email": "username@example.com",
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "state": "pending",
  "updated_at": "2012-01-01T12:00:00Z"
}

アプリの移動の一覧

既存のアプリの移動を一覧表示します。

Range ヘッダーの容認可能な順序の値は id または name です。

GET /account/app-transfers

curl の例

$ curl -n https://api.heroku.com/account/app-transfers \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: id, name
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "app": {
      "name": "example",
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    },
    "created_at": "2012-01-01T12:00:00Z",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "owner": {
      "email": "username@example.com",
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    },
    "recipient": {
      "email": "username@example.com",
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    },
    "state": "pending",
    "updated_at": "2012-01-01T12:00:00Z"
  }
]

アプリの移動の更新

既存のアプリの移動を更新します。

PATCH /account/app-transfers/{app_transfer_id_or_name}

必須パラメータ

名前	型	説明	例
state	文字列	アプリの移動の現在の状態次のうちのいずれか: `"pending"`、`"accepted"`、`"declined"`	`"pending"`

curl の例

$ curl -n -X PATCH https://api.heroku.com/account/app-transfers/$APP_TRANSFER_ID_OR_NAME \
  -d '{
  "state": "pending"
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "app": {
    "name": "example",
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "owner": {
    "email": "username@example.com",
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "recipient": {
    "email": "username@example.com",
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "state": "pending",
  "updated_at": "2012-01-01T12:00:00Z"
}

アプリの Webhook

安定性: 本番環境

Webhook サブスクリプションの詳細を表します。

アプリの Webhook の作成

アプリの Webhook サブスクリプションを作成します。

POST /apps/{app_id_or_name}/webhooks

必須パラメータ

名前	型	説明	例
include	配列	サブスクリプションが通知を提供するエンティティ	`["api:release"]`
level	文字列	`notify` の場合、Heroku は 1 つのファイアアンドフォーゲット配信を試行します。`sync`の場合、Heroku はリクエストが成功するか、または制限に達するまで複数の配信を試行します。次のうちのいずれか: `"notify"`、`"sync"`	`"notify"`
url	URI	Webhook の通知リクエストが送信される URL

オプションパラメータ

名前	型	説明	例
authorization	null 許容文字列	Heroku がすべての Webhook 通知に含めるカスタム `Authorization` ヘッダー	`"Bearer 9266671b2767f804c9d5809c2d384ed57d8f8ce1abd1043e1fb3fbbcb8c3"`
secret	null 許容文字列	Heroku がすべての Webhook 通知リクエストに署名するために使用する値 (この署名はリクエストの `Heroku-Webhook-Hmac-SHA256` ヘッダーに含まれる)	`"dcbff0c4430a2960a2552389d587bc58d30a37a8cf3f75f8fb77abe667ad"`

curl の例

$ curl -n -X POST https://api.heroku.com/apps/$APP_ID_OR_NAME/webhooks \
  -d '{
  "authorization": "Bearer 9266671b2767f804c9d5809c2d384ed57d8f8ce1abd1043e1fb3fbbcb8c3",
  "include": [
    "api:release"
  ],
  "level": "notify",
  "secret": "dcbff0c4430a2960a2552389d587bc58d30a37a8cf3f75f8fb77abe667ad",
  "url": "example"
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 201 Created
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "app": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  },
  "created_at": "2015-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "include": [
    "api:release"
  ],
  "level": "notify",
  "updated_at": "2015-01-01T12:00:00Z",
  "url": "example"
}

アプリの Webhook の削除

アプリの Webhook サブスクリプションを削除します。

DELETE /apps/{app_id_or_name}/webhooks/{app_webhook_id}

curl の例

$ curl -n -X DELETE https://api.heroku.com/apps/$APP_ID_OR_NAME/webhooks/$APP_WEBHOOK_ID \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "app": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  },
  "created_at": "2015-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "include": [
    "api:release"
  ],
  "level": "notify",
  "updated_at": "2015-01-01T12:00:00Z",
  "url": "example"
}

アプリの Webhook の情報

アプリの Webhook サブスクリプションに関する情報を返します。

GET /apps/{app_id_or_name}/webhooks/{app_webhook_id}

curl の例

$ curl -n https://api.heroku.com/apps/$APP_ID_OR_NAME/webhooks/$APP_WEBHOOK_ID \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "app": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  },
  "created_at": "2015-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "include": [
    "api:release"
  ],
  "level": "notify",
  "updated_at": "2015-01-01T12:00:00Z",
  "url": "example"
}

アプリの Webhook の一覧

特定のアプリのすべての Webhook サブスクリプションを一覧表示します。

Range ヘッダーの唯一の容認可能な順序の値は id です。

GET /apps/{app_id_or_name}/webhooks

curl の例

$ curl -n https://api.heroku.com/apps/$APP_ID_OR_NAME/webhooks \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: id
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "app": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "example"
    },
    "created_at": "2015-01-01T12:00:00Z",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "include": [
      "api:release"
    ],
    "level": "notify",
    "updated_at": "2015-01-01T12:00:00Z",
    "url": "example"
  }
]

アプリの Webhook の更新

アプリの Webhook サブスクリプションの詳細を更新します。

PATCH /apps/{app_id_or_name}/webhooks/{app_webhook_id}

オプションパラメータ

名前	型	説明	例
authorization	null 許容文字列	Heroku がすべての Webhook 通知に含めるカスタム `Authorization` ヘッダー	`"Bearer 9266671b2767f804c9d5809c2d384ed57d8f8ce1abd1043e1fb3fbbcb8c3"`
include	配列	サブスクリプションが通知を提供するエンティティ	`["api:release"]`
level	文字列	`notify` の場合、Heroku は 1 つのファイアアンドフォーゲット配信を試行します。`sync`の場合、Heroku はリクエストが成功するか、または制限に達するまで複数の配信を試行します。次のうちのいずれか: `"notify"`、`"sync"`	`"notify"`
secret	null 許容文字列	Heroku がすべての Webhook 通知リクエストに署名するために使用する値 (この署名はリクエストの `Heroku-Webhook-Hmac-SHA256` ヘッダーに含まれる)	`"dcbff0c4430a2960a2552389d587bc58d30a37a8cf3f75f8fb77abe667ad"`
url	URI	Webhook の通知リクエストが送信される URL

curl の例

$ curl -n -X PATCH https://api.heroku.com/apps/$APP_ID_OR_NAME/webhooks/$APP_WEBHOOK_ID \
  -d '{
  "authorization": "Bearer 9266671b2767f804c9d5809c2d384ed57d8f8ce1abd1043e1fb3fbbcb8c3",
  "include": [
    "api:release"
  ],
  "level": "notify",
  "secret": "dcbff0c4430a2960a2552389d587bc58d30a37a8cf3f75f8fb77abe667ad",
  "url": "example"
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "app": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  },
  "created_at": "2015-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "include": [
    "api:release"
  ],
  "level": "notify",
  "updated_at": "2015-01-01T12:00:00Z",
  "url": "example"
}

アプリの Webhook 配信

安定性: 本番環境

Webhook 通知 (その現在のステータスを含む) の配信を表します。

属性

名前	型	説明	例
created_at	日時	配信が作成された日時	`"2015-01-01T12:00:00Z"`
event:id	UUID	イベントの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
event:include	文字列	イベントが関連しているエンティティのタイプ	`"api:release"`
id	UUID	配信の一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
last_attempt	null 許容オブジェクト	配信の最後の試行	`null`
last_attempt:code	null 許容整数	試行中に受信された HTTP 応答コード	`null`
last_attempt:created_at	日時	試行が作成された日時	`"2015-01-01T12:00:00Z"`
last_attempt:error_class	null 許容文字列	試行中に発生したエラーのクラス	`null`
last_attempt:id	UUID	試行の一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
last_attempt:status	文字列	試行のステータス次のうちのいずれか: `"scheduled"`、`"succeeded"`、`"failed"`	`"scheduled"`
last_attempt:updated_at	日時	試行が更新された日時	`"2015-01-01T12:00:00Z"`
next_attempt_at	null 許容日時	配信が再試行される日時	`null`
num_attempts	整数	配信が試行された回数	`42`
status	文字列	配信のステータス次のうちのいずれか: `"pending"`、`"scheduled"`、`"retrying"`、`"failed"`、`"succeeded"`	`"pending"`
updated_at	日時	配信が最後に更新された日時	`"2015-01-01T12:00:00Z"`
webhook:id	UUID	Webhook の一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
webhook:level	文字列	`notify` の場合、Heroku は 1 つのファイアアンドフォーゲット配信を試行します。`sync`の場合、Heroku はリクエストが成功するか、または制限に達するまで複数の配信を試行します。次のうちのいずれか: `"notify"`、`"sync"`	`"notify"`

アプリの Webhook 配信の情報

既存の配信に関する情報を返します。

GET /apps/{app_id_or_name}/webhook-deliveries/{app_webhook_delivery_id}

curl の例

$ curl -n https://api.heroku.com/apps/$APP_ID_OR_NAME/webhook-deliveries/$APP_WEBHOOK_DELIVERY_ID \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "created_at": "2015-01-01T12:00:00Z",
  "event": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "include": "api:release"
  },
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "num_attempts": 42,
  "next_attempt_at": "2015-01-01T12:00:00Z",
  "last_attempt": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "code": 42,
    "error_class": "example",
    "status": "scheduled",
    "created_at": "2015-01-01T12:00:00Z",
    "updated_at": "2015-01-01T12:00:00Z"
  },
  "status": "pending",
  "updated_at": "2015-01-01T12:00:00Z",
  "webhook": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "level": "notify"
  }
}

アプリの Webhook 配信の一覧

アプリの既存の配信を一覧表示します。

Range ヘッダーの唯一の容認可能な順序の値は id です。

GET /apps/{app_id_or_name}/webhook-deliveries

curl の例

$ curl -n https://api.heroku.com/apps/$APP_ID_OR_NAME/webhook-deliveries \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: id
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "created_at": "2015-01-01T12:00:00Z",
    "event": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "include": "api:release"
    },
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "num_attempts": 42,
    "next_attempt_at": "2015-01-01T12:00:00Z",
    "last_attempt": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "code": 42,
      "error_class": "example",
      "status": "scheduled",
      "created_at": "2015-01-01T12:00:00Z",
      "updated_at": "2015-01-01T12:00:00Z"
    },
    "status": "pending",
    "updated_at": "2015-01-01T12:00:00Z",
    "webhook": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "level": "notify"
    }
  }
]

アプリの Webhook イベント

安定性: 本番環境

発生した Webhook イベントを表します。

属性

名前	型	説明	例
created_at	日時	イベントが作成された日時	`"2015-01-01T12:00:00Z"`
id	UUID	イベントの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
include	文字列	イベントが関連しているエンティティのタイプ	`"api:release"`
payload:action	文字列	発生したイベントのタイプ	`"create"`
payload:actor:email	メール	一意のメールアドレス	`"username@example.com"`
payload:actor:id	UUID	アカウントの識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
payload:data	オブジェクト	イベントの現在の詳細
payload:previous_data	オブジェクト	イベントの以前の詳細 (存在する場合)
payload:resource	文字列	イベントに関連付けられているリソースのタイプ	`"release"`
payload:version	文字列	イベントに関して提供される詳細のバージョン	`"1"`
updated_at	日時	イベントが最後に更新された日時	`"2015-01-01T12:00:00Z"`

アプリの Webhook イベントの情報

指定された Webhook イベントに関する情報を返します。

GET /apps/{app_id_or_name}/webhook-events/{app_webhook_event_id}

curl の例

$ curl -n https://api.heroku.com/apps/$APP_ID_OR_NAME/webhook-events/$APP_WEBHOOK_EVENT_ID \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "created_at": "2015-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "include": "api:release",
  "payload": {
    "action": "create",
    "actor": {
      "email": "username@example.com",
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    },
    "data": null,
    "previous_data": null,
    "resource": "release",
    "version": "1"
  },
  "updated_at": "2015-01-01T12:00:00Z"
}

アプリの Webhook イベントの一覧

アプリの既存の Webhook イベントを一覧表示します。

Range ヘッダーの唯一の容認可能な順序の値は id です。

GET /apps/{app_id_or_name}/webhook-events

curl の例

$ curl -n https://api.heroku.com/apps/$APP_ID_OR_NAME/webhook-events \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: id
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "created_at": "2015-01-01T12:00:00Z",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "include": "api:release",
    "payload": {
      "action": "create",
      "actor": {
        "email": "username@example.com",
        "id": "01234567-89ab-cdef-0123-456789abcdef"
      },
      "data": null,
      "previous_data": null,
      "resource": "release",
      "version": "1"
    },
    "updated_at": "2015-01-01T12:00:00Z"
  }
]

追跡記録アーカイブ

安定性: 本番環境

追跡記録アーカイブは、イベントを含む毎月の json 圧縮ファイルを表します。

属性

名前	型	説明	例
checksum	文字列	アーカイブのチェックサム	`"example"`
created_at	日時	アーカイブが作成された日時	`"2015-01-01T12:00:00Z"`
month	文字列	アーカイブの月次のうちのいずれか: `"01"`、`"02"`、`"03"`、`"04"`、`"05"`、`"06"`、`"07"`、`"08"`、`"09"`、`"10"`、`"11"`、`"12"`	`"10"`
size	整数	アーカイブのサイズ (バイト単位)	`100`
url	文字列	アーカイブをダウンロードする URL	`"example"`
year	整数	アーカイブの年範囲: `2017 <= value`	`2019`

追跡記録アーカイブの情報

1 か月のアーカイブを取得します。

GET /enterprise-accounts/{enterprise_account_id_or_name}/archives/{archive_year}/{archive_month}

curl の例

$ curl -n https://api.heroku.com/enterprise-accounts/$ENTERPRISE_ACCOUNT_ID_OR_NAME/archives/$ARCHIVE_YEAR/$ARCHIVE_MONTH \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "created_at": "2015-01-01T12:00:00Z",
  "month": "10",
  "year": 2019,
  "url": "example",
  "checksum": "example",
  "size": 100
}

追跡記録アーカイブの一覧

既存のアーカイブを一覧表示します。

Range ヘッダーの唯一の容認可能な順序の値は id です。

GET /enterprise-accounts/{enterprise_account_id_or_name}/archives

curl の例

$ curl -n https://api.heroku.com/enterprise-accounts/$ENTERPRISE_ACCOUNT_ID_OR_NAME/archives \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: id
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "created_at": "2015-01-01T12:00:00Z",
    "month": "10",
    "year": 2019,
    "url": "example",
    "checksum": "example",
    "size": 100
  }
]

追跡記録イベント

安定性: 本番環境

追跡記録イベントは、プラットフォーム上の一部のアクションを表します。

属性

名前	型	説明	例
action	文字列	イベントのアクション	`"example"`
actor:email	メール		`"username@example.com"`
actor:id	UUID		`"01234567-89ab-cdef-0123-456789abcdef"`
app:id	UUID		`"01234567-89ab-cdef-0123-456789abcdef"`
app:name	文字列		`"example"`
created_at	日時	イベントが作成された日時	`"2015-01-01T12:00:00Z"`
data	オブジェクト	イベントに固有のデータ
enterprise_account:id	UUID		`"01234567-89ab-cdef-0123-456789abcdef"`
enterprise_account:name	文字列		`"example"`
id	UUID	イベントの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
owner:email	メール		`"username@example.com"`
owner:id	UUID		`"01234567-89ab-cdef-0123-456789abcdef"`
request:ip_address	IPv4		`"192.0.2.1"`
team:id	UUID		`"01234567-89ab-cdef-0123-456789abcdef"`
team:name	文字列		`"example"`
type	文字列	イベントのタイプ	`"example"`

追跡記録イベントの一覧

既存のイベントを一覧表示します。現在の日付をデフォルトとして、1 日のすべてのイベントを返します。順序、アクター、アクション、タイプ、日付のクエリパラメータをクエリパラメータとして指定できます。たとえば、’/enterprise-accounts/:id/events?order=desc&actor=user@example.com&action=create&type=app&day=2020-09-30’ と指定すると、イベントは降順で返され、user@example.com というメールアドレスを持つユーザーがアプリで生成したイベントのみが返されます。

GET /enterprise-accounts/{enterprise_account_id_or_name}/events

curl の例

$ curl -n https://api.heroku.com/enterprise-accounts/$ENTERPRISE_ACCOUNT_ID_OR_NAME/events \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "created_at": "2015-01-01T12:00:00Z",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "type": "example",
    "action": "example",
    "actor": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "email": "username@example.com"
    },
    "app": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "example"
    },
    "owner": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "email": "username@example.com"
    },
    "enterprise_account": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "example"
    },
    "team": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "example"
    },
    "request": {
      "ip_address": "192.0.2.1"
    },
    "data": null
  }
]

ビルド

安定性: 本番環境

ビルドは、コードの tarball をビルドアーティファクトに変換するプロセスを表します。

属性

名前	型	説明	例
app:id	UUID	一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
buildpacks	null 許容配列	このビルドのために順番に実行された buildpack (Cedar 世代のアプリにのみ適用)	`null`
buildpacks/name	文字列	アプリの buildpack の Buildpack Registry 名	`"heroku/ruby"`
buildpacks/url	文字列	アプリの buildpack の URL	`"https://github.com/heroku/heroku-buildpack-ruby"`
created_at	日時	ビルドが作成された日時	`"2012-01-01T12:00:00Z"`
id	UUID	ビルドの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
output_stream_url	文字列	ビルドプロセスの出力は、ストリームとしてこの URL から入手できます。このストリームは、`text/plain` または `text/event-stream` のどちらかとして入手できます。クライアントは切断を処理できるよう準備し、`Range` ヘッダー (`text/plain` の場合) または `Last-Event-Id` ヘッダー (`text/event-stream` の場合) を送信することによってストリームを再開できます。	`"https://build-output.heroku.com/streams/01234567-89ab-cdef-0123-456789abcdef"`
release	null 許容オブジェクト	ビルドの結果として得られるリリース	`{"id":"01234567-89ab-cdef-0123-456789abcdef"}`
release:id	UUID	リリースの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
slug	null 許容オブジェクト	このビルドで作成された slug (Cedar 世代のアプリにのみ適用)	`null`
slug:id	UUID	slug の一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
source_blob:checksum	null 許容文字列	その完全性を確認するための gzip で圧縮された tarball のオプションのチェックサム	`"SHA256:e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"`
source_blob:url	文字列	ビルドのためのソースコードの gzip で圧縮された tar アーカイブがダウンロードされた URL	`"https://example.com/source.tgz?token=xyz"`
source_blob:version	null 許容文字列	gzip で圧縮された tarball のバージョン	`"v1.3.0"`
source_blob:version_description	null 許容文字列	gzip で圧縮された tarball のバージョンの説明。	`"* Fake User: Change session key"`
stack	文字列	ビルドのスタック	`"heroku-22"`
status	文字列	ビルドのステータス次のうちのいずれか: `"failed"`、`"pending"`、`"succeeded"`	`"succeeded"`
updated_at	日時	ビルドが更新された日時	`"2012-01-01T12:00:00Z"`
user:email	メール	一意のメールアドレス	`"username@example.com"`
user:id	UUID	アカウントの識別子	`"01234567-89ab-cdef-0123-456789abcdef"`

ビルドの作成

新しいビルドを作成します。

POST /apps/{app_id_or_name}/builds

必須パラメータ

名前	型	説明	例
source_blob:checksum	null 許容文字列	その完全性を確認するための gzip で圧縮された tarball のオプションのチェックサム	`"SHA256:e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"`
source_blob:url	文字列	ビルドのためのソースコードの gzip で圧縮された tar アーカイブがダウンロードされた URL	`"https://example.com/source.tgz?token=xyz"`
source_blob:version	null 許容文字列	gzip で圧縮された tarball のバージョン	`"v1.3.0"`
source_blob:version_description	null 許容文字列	gzip で圧縮された tarball のバージョンの説明。	`"* Fake User: Change session key"`

オプションパラメータ

名前	型	説明	例
buildpacks	null 許容配列	このビルドのために順番に実行された buildpack (Cedar 世代のアプリにのみ適用)	`null`
buildpacks/name	文字列	アプリの buildpack の Buildpack Registry 名	`"heroku/ruby"`
buildpacks/url	文字列	アプリの buildpack の URL	`"https://github.com/heroku/heroku-buildpack-ruby"`

curl の例

$ curl -n -X POST https://api.heroku.com/apps/$APP_ID_OR_NAME/builds \
  -d '{
  "buildpacks": [
    {
      "url": "https://github.com/heroku/heroku-buildpack-ruby",
      "name": "heroku/ruby"
    }
  ],
  "source_blob": {
    "checksum": "SHA256:e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
    "url": "https://example.com/source.tgz?token=xyz",
    "version": "v1.3.0",
    "version_description": "* Fake User: Change session key"
  }
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 201 Created
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "app": {
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "buildpacks": [
    {
      "url": "https://github.com/heroku/heroku-buildpack-ruby",
      "name": "heroku/ruby"
    }
  ],
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "output_stream_url": "https://build-output.heroku.com/streams/01234567-89ab-cdef-0123-456789abcdef",
  "source_blob": {
    "checksum": "SHA256:e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
    "url": "https://example.com/source.tgz?token=xyz",
    "version": "v1.3.0",
    "version_description": "* Fake User: Change session key"
  },
  "release": {
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "slug": {
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "stack": "heroku-22",
  "status": "succeeded",
  "updated_at": "2012-01-01T12:00:00Z",
  "user": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "email": "username@example.com"
  }
}

ビルドの情報

既存のビルドに関する情報。

GET /apps/{app_id_or_name}/builds/{build_id}

curl の例

$ curl -n https://api.heroku.com/apps/$APP_ID_OR_NAME/builds/$BUILD_ID \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "app": {
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "buildpacks": [
    {
      "url": "https://github.com/heroku/heroku-buildpack-ruby",
      "name": "heroku/ruby"
    }
  ],
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "output_stream_url": "https://build-output.heroku.com/streams/01234567-89ab-cdef-0123-456789abcdef",
  "source_blob": {
    "checksum": "SHA256:e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
    "url": "https://example.com/source.tgz?token=xyz",
    "version": "v1.3.0",
    "version_description": "* Fake User: Change session key"
  },
  "release": {
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "slug": {
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "stack": "heroku-22",
  "status": "succeeded",
  "updated_at": "2012-01-01T12:00:00Z",
  "user": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "email": "username@example.com"
  }
}

ビルドの一覧

既存のビルドを一覧表示します。

Range ヘッダーの容認可能な順序の値は id または started_at です。

GET /apps/{app_id_or_name}/builds

curl の例

$ curl -n https://api.heroku.com/apps/$APP_ID_OR_NAME/builds \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: id, started_at
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "app": {
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    },
    "buildpacks": [
      {
        "url": "https://github.com/heroku/heroku-buildpack-ruby",
        "name": "heroku/ruby"
      }
    ],
    "created_at": "2012-01-01T12:00:00Z",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "output_stream_url": "https://build-output.heroku.com/streams/01234567-89ab-cdef-0123-456789abcdef",
    "source_blob": {
      "checksum": "SHA256:e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
      "url": "https://example.com/source.tgz?token=xyz",
      "version": "v1.3.0",
      "version_description": "* Fake User: Change session key"
    },
    "release": {
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    },
    "slug": {
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    },
    "stack": "heroku-22",
    "status": "succeeded",
    "updated_at": "2012-01-01T12:00:00Z",
    "user": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "email": "username@example.com"
    }
  }
]

ビルドキャッシュの削除

ビルドキャッシュを破棄します。

DELETE /apps/{app_id_or_name}/build-cache

curl の例

$ curl -n -X DELETE https://api.heroku.com/apps/$APP_ID_OR_NAME/build-cache \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 202 Accepted
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

ビルドのキャンセル

実行中のビルドをキャンセルします。

DELETE /apps/{app_id_or_name}/builds/{build_id}

curl の例

$ curl -n -X DELETE https://api.heroku.com/apps/$APP_ID_OR_NAME/builds/$BUILD_ID \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "app": {
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "buildpacks": [
    {
      "url": "https://github.com/heroku/heroku-buildpack-ruby",
      "name": "heroku/ruby"
    }
  ],
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "output_stream_url": "https://build-output.heroku.com/streams/01234567-89ab-cdef-0123-456789abcdef",
  "source_blob": {
    "checksum": "SHA256:e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
    "url": "https://example.com/source.tgz?token=xyz",
    "version": "v1.3.0",
    "version_description": "* Fake User: Change session key"
  },
  "release": {
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "slug": {
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "stack": "heroku-22",
  "status": "succeeded",
  "updated_at": "2012-01-01T12:00:00Z",
  "user": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "email": "username@example.com"
  }
}

buildpack インストール

安定性: 本番環境

buildpack インストールは、アプリに対して実行される buildpack を表します。

属性

名前	型	説明	例
buildpack:name	文字列	アプリの buildpack の Buildpack Registry 名または URL	`"heroku/ruby"`
buildpack:url	文字列	アプリの buildpack の場所。URL (正式でない buildpack) または内部 URN (Heroku の正式な buildpack)。	`"https://github.com/heroku/heroku-buildpack-ruby"`
ordinal	整数	buildpack が実行される順序を決定します。	`0`

buildpack インストールの更新

アプリの buildpack インストールを更新します。

PUT /apps/{app_id_or_name}/buildpack-installations

必須パラメータ

名前	型	説明	例
updates	配列	buildpack 属性は、名前、URL、または URN を受け入れることができます。	`[{"buildpack":"https://github.com/heroku/heroku-buildpack-ruby"}]`

curl の例

$ curl -n -X PUT https://api.heroku.com/apps/$APP_ID_OR_NAME/buildpack-installations \
  -d '{
  "updates": [
    {
      "buildpack": "https://github.com/heroku/heroku-buildpack-ruby"
    }
  ]
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "ordinal": 0,
    "buildpack": {
      "url": "https://github.com/heroku/heroku-buildpack-ruby",
      "name": "heroku/ruby"
    }
  }
]

buildpack インストールの一覧

アプリの既存の buildpack インストールを一覧表示します。

GET /apps/{app_id_or_name}/buildpack-installations

curl の例

$ curl -n https://api.heroku.com/apps/$APP_ID_OR_NAME/buildpack-installations \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "ordinal": 0,
    "buildpack": {
      "url": "https://github.com/heroku/heroku-buildpack-ruby",
      "name": "heroku/ruby"
    }
  }
]

共同作業者

安定性: 本番環境

共同作業者は、Heroku 上のアプリへのアクセス権が与えられたアカウントを表します。

属性

名前	型	説明	例
app:id	UUID	一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
app:name	文字列	アプリの名前パターン: `^[a-z][a-z0-9-]{1,28}[a-z0-9]$`	`"example"`
created_at	日時	共同作業者が作成された日時	`"2012-01-01T12:00:00Z"`
id	UUID	共同作業者の一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
permissions	配列		`[{"name":"view","description":"Can manage config, deploy, run commands and restart the app."}]`
role	null 許容文字列	チーム内のロール次のうちのいずれか: `"admin"`、`"collaborator"`、`"member"`、`"owner"`、`null`	`"admin"`
updated_at	日時	共同作業者が更新された日時	`"2012-01-01T12:00:00Z"`
user:email	メール	一意のメールアドレス	`"username@example.com"`
user:federated	ブール値	ユーザーがフェデレーションされ、ID プロバイダーに属しているかどうか	`false`
user:id	UUID	アカウントの識別子	`"01234567-89ab-cdef-0123-456789abcdef"`

共同作業者の作成

新しい共同作業者を作成します。

POST /apps/{app_id_or_name}/collaborators

必須パラメータ

名前	型	説明	例
user	文字列	一意のメールアドレス、アカウントの識別子、または現在承認されているユーザーへの暗黙的な参照	`"username@example.com"`、`"01234567-89ab-cdef-0123-456789abcdef"`、または `"~"`

オプションパラメータ

名前	型	説明	例
silent	ブール値	共同作業者を作成したときのメールの招待状を抑制するかどうか	`false`

curl の例

$ curl -n -X POST https://api.heroku.com/apps/$APP_ID_OR_NAME/collaborators \
  -d '{
  "silent": false,
  "user": "01234567-89ab-cdef-0123-456789abcdef"
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 201 Created
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "app": {
    "name": "example",
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "permissions": [
    {
      "name": "view",
      "description": "Can manage config, deploy, run commands and restart the app."
    }
  ],
  "role": "admin",
  "updated_at": "2012-01-01T12:00:00Z",
  "user": {
    "email": "username@example.com",
    "federated": false,
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  }
}

共同作業者の削除

既存の共同作業者を削除します。

DELETE /apps/{app_id_or_name}/collaborators/{collaborator_email_or_id}

curl の例

$ curl -n -X DELETE https://api.heroku.com/apps/$APP_ID_OR_NAME/collaborators/$COLLABORATOR_EMAIL_OR_ID \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "app": {
    "name": "example",
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "permissions": [
    {
      "name": "view",
      "description": "Can manage config, deploy, run commands and restart the app."
    }
  ],
  "role": "admin",
  "updated_at": "2012-01-01T12:00:00Z",
  "user": {
    "email": "username@example.com",
    "federated": false,
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  }
}

共同作業者の情報

既存の共同作業者に関する情報。

GET /apps/{app_id_or_name}/collaborators/{collaborator_email_or_id}

curl の例

$ curl -n https://api.heroku.com/apps/$APP_ID_OR_NAME/collaborators/$COLLABORATOR_EMAIL_OR_ID \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "app": {
    "name": "example",
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "permissions": [
    {
      "name": "view",
      "description": "Can manage config, deploy, run commands and restart the app."
    }
  ],
  "role": "admin",
  "updated_at": "2012-01-01T12:00:00Z",
  "user": {
    "email": "username@example.com",
    "federated": false,
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  }
}

共同作業者の一覧

既存の共同作業者を一覧表示します。

Range ヘッダーの容認可能な順序の値は email または id です。

GET /apps/{app_id_or_name}/collaborators

curl の例

$ curl -n https://api.heroku.com/apps/$APP_ID_OR_NAME/collaborators \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: email, id
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "app": {
      "name": "example",
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    },
    "created_at": "2012-01-01T12:00:00Z",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "permissions": [
      {
        "name": "view",
        "description": "Can manage config, deploy, run commands and restart the app."
      }
    ],
    "role": "admin",
    "updated_at": "2012-01-01T12:00:00Z",
    "user": {
      "email": "username@example.com",
      "federated": false,
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    }
  }
]

環境設定

安定性: 本番環境

環境設定を使用すると、Heroku 上のアプリに提供される設定情報を管理できます。

アプリの環境設定の情報

アプリの環境設定を取得します。

GET /apps/{app_id_or_name}/config-vars

curl の例

$ curl -n https://api.heroku.com/apps/$APP_ID_OR_NAME/config-vars \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "FOO": "bar",
  "BAZ": "qux"
}

アプリのリリースの環境設定の情報

リリースの環境設定を取得します。

GET /apps/{app_id_or_name}/releases/{release_id_or_version}/config-vars

curl の例

$ curl -n https://api.heroku.com/apps/$APP_ID_OR_NAME/releases/$RELEASE_ID_OR_VERSION/config-vars \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "FOO": "bar",
  "BAZ": "qux"
}

環境設定の更新

アプリの環境設定を更新します。再び設定することによって既存の環境設定を更新したり、null に設定することによって削除したりできます。

PATCH /apps/{app_id_or_name}/config-vars

curl の例

$ curl -n -X PATCH https://api.heroku.com/apps/$APP_ID_OR_NAME/config-vars \
  -d '{
  "FOO": "bar",
  "BAZ": "qux"
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "FOO": "bar",
  "BAZ": "qux"
}

クレジット

安定性: 開発

クレジットは、アカウントに追加料金が割り当てられる前に使い果たされる値を表します。

属性

名前	型	説明	例
amount	数値	クレジットの合計値 (セント)	`10000`
balance	数値	クレジットの残りの値 (セント)	`5000`
created_at	日時	クレジットが作成された日時	`"2012-01-01T12:00:00Z"`
expires_at	日時	クレジットが期限切れになる日時	`"2012-01-01T12:00:00Z"`
id	UUID	クレジットの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
title	文字列	クレジットの名前	`"gift card"`
updated_at	日時	クレジットが更新された日時	`"2012-01-01T12:00:00Z"`

クレジットの作成

新しいクレジットを作成します。

POST /account/credits

オプションパラメータ

名前	型	説明	例
code1	文字列	割引カードの最初のコード	`"012abc"`
code2	文字列	割引カードの 2 番目のコード	`"012abc"`

curl の例

$ curl -n -X POST https://api.heroku.com/account/credits \
  -d '{
  "code1": "012abc",
  "code2": "012abc"
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 201 Created
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "amount": 10000,
  "balance": 5000,
  "created_at": "2012-01-01T12:00:00Z",
  "expires_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "title": "gift card",
  "updated_at": "2012-01-01T12:00:00Z"
}

クレジットの情報

既存のクレジットに関する情報。

GET /account/credits/{credit_id}

curl の例

$ curl -n https://api.heroku.com/account/credits/$CREDIT_ID \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "amount": 10000,
  "balance": 5000,
  "created_at": "2012-01-01T12:00:00Z",
  "expires_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "title": "gift card",
  "updated_at": "2012-01-01T12:00:00Z"
}

クレジットの一覧

既存のクレジットを一覧表示します。

Range ヘッダーの唯一の容認可能な順序の値は id です。

GET /account/credits

curl の例

$ curl -n https://api.heroku.com/account/credits \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: id
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "amount": 10000,
    "balance": 5000,
    "created_at": "2012-01-01T12:00:00Z",
    "expires_at": "2012-01-01T12:00:00Z",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "title": "gift card",
    "updated_at": "2012-01-01T12:00:00Z"
  }
]

ドメイン

安定性: 本番環境

ドメインは、Heroku 上のアプリにどのような Web ルートをルーティングするかを定義します。

属性

名前	型	説明	例
acm_status	null 許容文字列	このレコードの ACM のステータス	`"pending"`
acm_status_reason	null 許容文字列	このレコードの ACM のステータスの理由	`"Failing CCA check"`
app:id	UUID	一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
app:name	文字列	アプリの名前パターン: `^[a-z][a-z0-9-]{1,28}[a-z0-9]$`	`"example"`
cname	null 許容文字列	正規名レコード、ドメインを指すためのアドレス	`"example.herokudns.com"`
created_at	日時	ドメインが作成された日時	`"2012-01-01T12:00:00Z"`
hostname	URI	完全なホスト名	`"subdomain.example.com"`
id	UUID	このドメインの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
kind	文字列	ドメイン名のタイプ次のうちのいずれか: `"heroku"`、`"custom"`	`"custom"`
sni_endpoint	null 許容オブジェクト	ドメインが関連付けられている SNI エンドポイント	`null`
sni_endpoint:id	UUID	この SNI エンドポイントの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
sni_endpoint:name	文字列	SNI エンドポイントの一意の名前パターン: `^[a-z][a-z0-9-]{2,29}$`	`"example"`
status	文字列	このレコードの CNAME のステータス	`"pending"`
updated_at	日時	ドメインが更新された日時	`"2012-01-01T12:00:00Z"`

ドメインの作成

新しいドメインを作成します。

POST /apps/{app_id_or_name}/domains

必須パラメータ

名前	型	説明	例
hostname	URI	完全なホスト名	`"subdomain.example.com"`
sni_endpoint	null 許容文字列	null、SNI エンドポイントの一意識別子または名前	`null`

curl の例

$ curl -n -X POST https://api.heroku.com/apps/$APP_ID_OR_NAME/domains \
  -d '{
  "hostname": "subdomain.example.com",
  "sni_endpoint": null
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 201 Created
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "acm_status": "pending",
  "acm_status_reason": "Failing CCA check",
  "app": {
    "name": "example",
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "cname": "example.herokudns.com",
  "created_at": "2012-01-01T12:00:00Z",
  "hostname": "subdomain.example.com",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "kind": "custom",
  "updated_at": "2012-01-01T12:00:00Z",
  "status": "pending",
  "sni_endpoint": {
    "name": "example",
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  }
}

ドメイン更新

SNI エンドポイントを関連付けます。

PATCH /apps/{app_id_or_name}/domains/{domain_id_or_hostname}

必須パラメータ

名前	型	説明	例
sni_endpoint	null 許容文字列	null、SNI エンドポイントの一意識別子または名前	`null`

curl の例

$ curl -n -X PATCH https://api.heroku.com/apps/$APP_ID_OR_NAME/domains/$DOMAIN_ID_OR_HOSTNAME \
  -d '{
  "sni_endpoint": null
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "acm_status": "pending",
  "acm_status_reason": "Failing CCA check",
  "app": {
    "name": "example",
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "cname": "example.herokudns.com",
  "created_at": "2012-01-01T12:00:00Z",
  "hostname": "subdomain.example.com",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "kind": "custom",
  "updated_at": "2012-01-01T12:00:00Z",
  "status": "pending",
  "sni_endpoint": {
    "name": "example",
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  }
}

ドメインの削除

既存のドメインを削除します。

DELETE /apps/{app_id_or_name}/domains/{domain_id_or_hostname}

curl の例

$ curl -n -X DELETE https://api.heroku.com/apps/$APP_ID_OR_NAME/domains/$DOMAIN_ID_OR_HOSTNAME \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "acm_status": "pending",
  "acm_status_reason": "Failing CCA check",
  "app": {
    "name": "example",
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "cname": "example.herokudns.com",
  "created_at": "2012-01-01T12:00:00Z",
  "hostname": "subdomain.example.com",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "kind": "custom",
  "updated_at": "2012-01-01T12:00:00Z",
  "status": "pending",
  "sni_endpoint": {
    "name": "example",
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  }
}

ドメインの情報

既存のドメインに関する情報。

GET /apps/{app_id_or_name}/domains/{domain_id_or_hostname}

curl の例

$ curl -n https://api.heroku.com/apps/$APP_ID_OR_NAME/domains/$DOMAIN_ID_OR_HOSTNAME \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "acm_status": "pending",
  "acm_status_reason": "Failing CCA check",
  "app": {
    "name": "example",
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "cname": "example.herokudns.com",
  "created_at": "2012-01-01T12:00:00Z",
  "hostname": "subdomain.example.com",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "kind": "custom",
  "updated_at": "2012-01-01T12:00:00Z",
  "status": "pending",
  "sni_endpoint": {
    "name": "example",
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  }
}

ドメインの一覧

既存のドメインを一覧表示します。

Range ヘッダーの容認可能な順序の値は hostname または id です。

GET /apps/{app_id_or_name}/domains

curl の例

$ curl -n https://api.heroku.com/apps/$APP_ID_OR_NAME/domains \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: hostname, id
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "acm_status": "pending",
    "acm_status_reason": "Failing CCA check",
    "app": {
      "name": "example",
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    },
    "cname": "example.herokudns.com",
    "created_at": "2012-01-01T12:00:00Z",
    "hostname": "subdomain.example.com",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "kind": "custom",
    "updated_at": "2012-01-01T12:00:00Z",
    "status": "pending",
    "sni_endpoint": {
      "name": "example",
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    }
  }
]

dyno

安定性: 本番環境

dyno は、Heroku 上のアプリの実行中プロセスをカプセル化します。dyno サイズについての詳細は、https://devcenter.heroku.com/articles/dyno-types を参照してください。

属性

名前	型	説明	例
app:id	UUID	一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
app:name	文字列	アプリの名前パターン: `^[a-z][a-z0-9-]{1,28}[a-z0-9]$`	`"example"`
attach_url	null 許容文字列	アタッチされたプロセスの場合は出力を、アタッチされていないプロセスの場合は null をストリーミングするための URL	`"rendezvous://rendezvous.runtime.heroku.com:5000/{rendezvous-id}"`
command	文字列	このプロセスを起動するために使用されるコマンド	`"bash"`
created_at	日時	dyno が作成された日時	`"2012-01-01T12:00:00Z"`
id	UUID	この dyno の一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
name	文字列	この dyno 上のこのプロセスの名前	`"run.1"`
release:id	UUID	リリースの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
release:version	整数	リリースに割り当てられている固有のバージョン	`11`
size	文字列	dyno サイズ	`"standard-1X"`
state	文字列	プロセスの現在のステータス (クラッシュ、ダウン、アイドル、開始中、アップのいずれか)	`"up"`
type	文字列	プロセスのタイプ	`"run"`
updated_at	日時	プロセスの状態が最後に変更された日時	`"2012-01-01T12:00:00Z"`

dyno の作成

新しい dyno を作成します。

POST /apps/{app_id_or_name}/dynos

必須パラメータ

名前	型	説明	例
command	文字列	このプロセスを起動するために使用されるコマンド	`"bash"`

オプションパラメータ

名前	型	説明	例
attach	ブール値	出力をストリーミングするかどうか	`true`
env	オブジェクト	dyno 環境設定に追加するカスタム環境	`{"COLUMNS":"80","LINES":"24"}`
force_no_tty	null 許容ブール値	アタッチされた One-off dyno を強制的に tty で実行されないようにします。	`null`
size	文字列	dyno サイズ	`"standard-1X"`
time_to_live	整数	dyno が期限切れになるまでの秒数。その後、すぐに強制終了されます。最大 86400 秒 (24 時間)。	`1800`
type	文字列	プロセスのタイプ	`"run"`

curl の例

$ curl -n -X POST https://api.heroku.com/apps/$APP_ID_OR_NAME/dynos \
  -d '{
  "attach": true,
  "command": "bash",
  "env": {
    "COLUMNS": "80",
    "LINES": "24"
  },
  "force_no_tty": null,
  "size": "standard-1X",
  "type": "run",
  "time_to_live": 1800
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 201 Created
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "attach_url": "rendezvous://rendezvous.runtime.heroku.com:5000/{rendezvous-id}",
  "command": "bash",
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "name": "run.1",
  "release": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "version": 11
  },
  "app": {
    "name": "example",
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "size": "standard-1X",
  "state": "up",
  "type": "run",
  "updated_at": "2012-01-01T12:00:00Z"
}

dyno の再起動

dyno を再起動します。

DELETE /apps/{app_id_or_name}/dynos/{dyno_id_or_name}

curl の例

$ curl -n -X DELETE https://api.heroku.com/apps/$APP_ID_OR_NAME/dynos/$DYNO_ID_OR_NAME \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 202 Accepted
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

dyno の再起動フォーメーション

指定したフォーメーションタイプの dyno を再起動します。

DELETE /apps/{app_id_or_name}/formations/{dyno_formation_type}

curl の例

$ curl -n -X DELETE https://api.heroku.com/apps/$APP_ID_OR_NAME/formations/$DYNO_FORMATION_TYPE \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 202 Accepted
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

すべての dyno の再起動

すべての dyno を再起動します。

DELETE /apps/{app_id_or_name}/dynos

curl の例

$ curl -n -X DELETE https://api.heroku.com/apps/$APP_ID_OR_NAME/dynos \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 202 Accepted
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

dyno の停止

dyno を停止します。

POST /apps/{app_id_or_name}/dynos/{dyno_id_or_name}/actions/stop

curl の例

$ curl -n -X POST https://api.heroku.com/apps/$APP_ID_OR_NAME/dynos/$DYNO_ID_OR_NAME/actions/stop \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 202 Accepted
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

dyno の停止フォーメーション

指定したフォーメーションタイプの dyno を停止します。

POST /apps/{app_id_or_name}/formations/{dyno_formation_type}/actions/stop

curl の例

$ curl -n -X POST https://api.heroku.com/apps/$APP_ID_OR_NAME/formations/$DYNO_FORMATION_TYPE/actions/stop \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 202 Accepted
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

dyno の情報

既存の dyno に関する情報。

GET /apps/{app_id_or_name}/dynos/{dyno_id_or_name}

curl の例

$ curl -n https://api.heroku.com/apps/$APP_ID_OR_NAME/dynos/$DYNO_ID_OR_NAME \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "attach_url": "rendezvous://rendezvous.runtime.heroku.com:5000/{rendezvous-id}",
  "command": "bash",
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "name": "run.1",
  "release": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "version": 11
  },
  "app": {
    "name": "example",
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "size": "standard-1X",
  "state": "up",
  "type": "run",
  "updated_at": "2012-01-01T12:00:00Z"
}

dyno の一覧

既存の dyno を一覧表示します。

Range ヘッダーの容認可能な順序の値は id または name です。

GET /apps/{app_id_or_name}/dynos

curl の例

$ curl -n https://api.heroku.com/apps/$APP_ID_OR_NAME/dynos \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: id, name
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "attach_url": "rendezvous://rendezvous.runtime.heroku.com:5000/{rendezvous-id}",
    "command": "bash",
    "created_at": "2012-01-01T12:00:00Z",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "run.1",
    "release": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "version": 11
    },
    "app": {
      "name": "example",
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    },
    "size": "standard-1X",
    "state": "up",
    "type": "run",
    "updated_at": "2012-01-01T12:00:00Z"
  }
]

dyno サイズ

安定性: プロトタイプ

dyno サイズは、dyno に割り当てることができるサイズの値と詳細です。これらの情報についても、https://devcenter.heroku.com/articles/dyno-types を参照してください。

属性

名前	型	説明	例
architecture	文字列	この dyno サイズの CPU アーキテクチャ	`"amd64"`
compute	整数	vCPU の最小数。負荷によっては、専用でない方が多く割り当てられることがあります。	`1`
cost	null 許容オブジェクト	この dyno サイズの価格情報	`null`
dedicated	ブール値	この dyno が 1 人のユーザー専用になるかどうか	`false`
generation:id	UUID	この dyno サイズの Heroku プラットフォームの世代の一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
generation:name	文字列	この dyno サイズの Heroku プラットフォームの世代の一意の名前	`"cedar"`
id	UUID	dyno サイズの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
memory	数値	RAM の量 (GB 単位)	`0.5`
name	文字列	dyno サイズの名前	`"eco"`
precise_dyno_units	数値	Heroku Enterprise 顧客の小数点第 2 位までの消費の単位	`0.28`
private_space_only	ブール値	この dyno を Private Space にのみプロビジョニングできるかどうか	`false`

dyno サイズの情報

既存の dyno サイズに関する情報。

GET /dyno-sizes/{dyno_size_id_or_name}

curl の例

$ curl -n https://api.heroku.com/dyno-sizes/$DYNO_SIZE_ID_OR_NAME \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "architecture": "amd64",
  "compute": 1,
  "cost": null,
  "dedicated": false,
  "precise_dyno_units": 0.28,
  "generation": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "cedar"
  },
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "memory": 0.5,
  "name": "eco",
  "private_space_only": false
}

dyno サイズの一覧

既存の dyno サイズを一覧表示します。

Range ヘッダーの容認可能な順序の値は id または name です。

GET /dyno-sizes

curl の例

$ curl -n https://api.heroku.com/dyno-sizes \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: id, name
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "architecture": "amd64",
    "compute": 1,
    "cost": null,
    "dedicated": false,
    "precise_dyno_units": 0.28,
    "generation": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "cedar"
    },
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "memory": 0.5,
    "name": "eco",
    "private_space_only": false
  }
]

dyno サイズの一覧 (アプリの dyno サイズ)

アプリで利用可能な dyno サイズを一覧表示します

GET /apps/{app_id_or_name}/available-dyno-sizes

curl の例

$ curl -n https://api.heroku.com/apps/$APP_ID_OR_NAME/available-dyno-sizes \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "architecture": "amd64",
    "compute": 1,
    "cost": null,
    "dedicated": false,
    "precise_dyno_units": 0.28,
    "generation": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "cedar"
    },
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "memory": 0.5,
    "name": "eco",
    "private_space_only": false
  }
]

エンタープライズアカウント

安定性: 開発

エンタープライズアカウントを使用すると、会社はその開発チームと請求を管理できます。

属性

名前	型	説明	例
created_at	日時	エンタープライズアカウントが作成された日時	`"2012-01-01T12:00:00Z"`
id	UUID	エンタープライズアカウントの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
identity_provider	null 許容オブジェクト	エンタープライズアカウントに関連付けられている ID プロバイダー	`null`
identity_provider:id	UUID	この ID プロバイダーの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
identity_provider:name	文字列	この ID プロバイダーのユーザーにわかりやすい一意識別子	`"acme-sso"`
identity_provider:owner:id	UUID	所有者の一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
identity_provider:owner:name	文字列	所有者の名前	`"acme"`
identity_provider:owner:type	文字列	所有者のタイプ次のうちのいずれか: `"team"`、`"enterprise-account"`	`"team"`
name	文字列	エンタープライズアカウントの一意の名前	`"example"`
permissions	配列	このエンタープライズアカウントでの現在のユーザーのアクセス許可	`["view"]`
trial	ブール値	このエンタープライズアカウントが試用版であるかどうか	`false`
updated_at	日時	エンタープライズアカウントが更新された日時	`"2012-01-01T12:00:00Z"`

エンタープライズアカウントの一覧

メンバーになっているエンタープライズアカウントを一覧表示します。

Range ヘッダーの容認可能な順序の値は id または name です。

GET /enterprise-accounts

curl の例

$ curl -n https://api.heroku.com/enterprise-accounts \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: id, name
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "created_at": "2012-01-01T12:00:00Z",
    "name": "example",
    "updated_at": "2012-01-01T12:00:00Z",
    "permissions": [
      "view"
    ],
    "trial": false,
    "identity_provider": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "acme-sso",
      "owner": {
        "id": "01234567-89ab-cdef-0123-456789abcdef",
        "name": "acme",
        "type": "team"
      }
    }
  }
]

エンタープライズアカウントの情報

エンタープライズアカウントに関する情報。

GET /enterprise-accounts/{enterprise_account_id_or_name}

curl の例

$ curl -n https://api.heroku.com/enterprise-accounts/$ENTERPRISE_ACCOUNT_ID_OR_NAME \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "created_at": "2012-01-01T12:00:00Z",
  "name": "example",
  "updated_at": "2012-01-01T12:00:00Z",
  "permissions": [
    "view"
  ],
  "trial": false,
  "identity_provider": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "acme-sso",
    "owner": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "acme",
      "type": "team"
    }
  }
}

エンタープライズアカウントの更新

エンタープライズアカウントのプロパティを更新します。

PATCH /enterprise-accounts/{enterprise_account_id_or_name}

オプションパラメータ

名前	型	説明	例
name	文字列	エンタープライズアカウントの一意の名前	`"example"`

curl の例

$ curl -n -X PATCH https://api.heroku.com/enterprise-accounts/$ENTERPRISE_ACCOUNT_ID_OR_NAME \
  -d '{
  "name": "example"
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "created_at": "2012-01-01T12:00:00Z",
  "name": "example",
  "updated_at": "2012-01-01T12:00:00Z",
  "permissions": [
    "view"
  ],
  "trial": false,
  "identity_provider": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "acme-sso",
    "owner": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "acme",
      "type": "team"
    }
  }
}

エンタープライズアカウントの毎日の使用状況

安定性: 開発

毎日の解像度でのエンタープライズアカウントの使用状況。

属性

名前	型	説明	例
addons	数値	使用されている合計アドオンクレジット	`250.0`
data	数値	ファーストパーティのアドオンに使用されている合計アドオンクレジット	`34.89`
date	日付	使用状況の日付	`"2019-01-01"`
dynos	数値	使用されている dyno の数	`1.548`
id	UUID	エンタープライズアカウントの識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
name	文字列	エンタープライズアカウントの名前	`"example-co"`
partner	数値	サードパーティのアドオンに使用されている合計アドオンクレジット	`12.34`
space	数値	使用されている Space クレジット	`1.548`
teams/addons	数値	使用されている合計アドオンクレジット	`250.0`
teams/apps	配列	チームでのアプリの使用状況	`[{"addons":250.0,"app_name":"example","data":34.89,"dynos":1.548,"partner":12.34}]`
teams/data	数値	ファーストパーティのアドオンに使用されている合計アドオンクレジット	`34.89`
teams/dynos	数値	使用されている dyno の数	`1.548`
teams/id	UUID	チームの識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
teams/name	文字列	チームの名前	`"ops"`
teams/partner	数値	サードパーティのアドオンに使用されている合計アドオンクレジット	`12.34`
teams/space	数値	使用されている Space クレジット	`1.548`

エンタープライズアカウントの毎日の使用状況の情報

日数の範囲でのエンタープライズアカウントの使用状況を取得します。開始日と終了日は、YYYY-MM-DD の日付形式を使用してクエリパラメータとして指定できます。エンタープライズアカウントの識別子については、エンタープライズアカウントの一覧を参照してください。

GET /enterprise-accounts/{enterprise_account_id}/usage/daily

必須パラメータ

名前	型	説明	例
start	文字列	範囲の開始日パターン: `^[0-9]{4}-[0-9]{2}-[0-9]{2}$`	`"2019-01-25"`

オプションパラメータ

名前	型	説明	例
end	文字列	範囲の終了日パターン: `^[0-9]{4}-[0-9]{2}-[0-9]{2}$`	`"2019-02-25"`

curl の例

$ curl -n https://api.heroku.com/enterprise-accounts/$ENTERPRISE_ACCOUNT_ID/usage/daily \
 -G \
  -d start=2019-01-25 \
  -d end=2019-02-25 \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "addons": 250.0,
    "teams": [
      {
        "addons": 250.0,
        "apps": [
          {
            "addons": 250.0,
            "app_name": "example",
            "data": 34.89,
            "dynos": 1.548,
            "partner": 12.34
          }
        ],
        "data": 34.89,
        "dynos": 1.548,
        "id": "01234567-89ab-cdef-0123-456789abcdef",
        "name": "ops",
        "partner": 12.34,
        "space": 1.548
      }
    ],
    "data": 34.89,
    "date": "2019-01-01",
    "dynos": 1.548,
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example-co",
    "partner": 12.34,
    "space": 1.548
  }
]

エンタープライズアカウントメンバー

安定性: 開発

エンタープライズアカウントメンバーは、エンタープライズアカウントにアクセスできるユーザーです。

属性

名前	型	説明	例
enterprise_account:id	UUID	エンタープライズアカウントの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
enterprise_account:name	文字列	エンタープライズアカウントの一意の名前	`"example"`
id	UUID	メンバーの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
identity_provider	null 許容オブジェクト	メンバーがフェデレーションされている ID プロバイダーの情報	`null`
identity_provider:id	UUID	この ID プロバイダーの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
identity_provider:name	文字列	ID プロバイダーの名前	`"acme"`
identity_provider:owner:id	UUID	所有者の一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
identity_provider:owner:name	文字列	所有者の名前	`"acme"`
identity_provider:owner:type	文字列	所有者のタイプ次のうちのいずれか: `"team"`、`"enterprise-account"`	`"team"`
identity_provider:redacted	ブール値	identity_provider 情報が編集されているかどうか	`false`
permissions/description	文字列		`"View enterprise account members and teams."`
permissions/name	文字列	エンタープライズアカウントのアクセス許可次のうちのいずれか: `"view"`、`"create"`、`"manage"`、`"billing"`	`"view"`
two_factor_authentication	ブール値	エンタープライズアカウントメンバーで 2 要素認証が有効になっているかどうか	`true`
user:email	メール	一意のメールアドレス	`"username@example.com"`
user:id	UUID	アカウントの識別子	`"01234567-89ab-cdef-0123-456789abcdef"`

エンタープライズアカウントメンバーの一覧

エンタープライズアカウントのメンバーを一覧表示します。

Range ヘッダーの唯一の容認可能な順序の値は id です。

GET /enterprise-accounts/{enterprise_account_id_or_name}/members

curl の例

$ curl -n https://api.heroku.com/enterprise-accounts/$ENTERPRISE_ACCOUNT_ID_OR_NAME/members \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: id
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "enterprise_account": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "example"
    },
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "permissions": [
      {
        "description": "View enterprise account members and teams.",
        "name": "view"
      }
    ],
    "user": {
      "email": "username@example.com",
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    },
    "two_factor_authentication": true,
    "identity_provider": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "acme",
      "redacted": false,
      "owner": {
        "id": "01234567-89ab-cdef-0123-456789abcdef",
        "name": "acme",
        "type": "team"
      }
    }
  }
]

エンタープライズアカウントメンバーの作成

エンタープライズアカウントのメンバーを作成します。

POST /enterprise-accounts/{enterprise_account_id_or_name}/members

必須パラメータ

名前	型	説明	例
permissions	配列	エンタープライズアカウントのアクセス許可	`["view"]`
user	文字列	アカウントの一意のメールアドレスまたは識別子	`"username@example.com"` または `"01234567-89ab-cdef-0123-456789abcdef"`

オプションパラメータ

名前	型	説明	例
federated	ブール値	メンバーシップが SSO JIT の一部として作成されているかどうか	`false`

curl の例

$ curl -n -X POST https://api.heroku.com/enterprise-accounts/$ENTERPRISE_ACCOUNT_ID_OR_NAME/members \
  -d '{
  "user": "01234567-89ab-cdef-0123-456789abcdef",
  "permissions": [
    "view"
  ],
  "federated": false
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 201 Created
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "enterprise_account": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  },
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "permissions": [
    {
      "description": "View enterprise account members and teams.",
      "name": "view"
    }
  ],
  "user": {
    "email": "username@example.com",
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "two_factor_authentication": true,
  "identity_provider": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "acme",
    "redacted": false,
    "owner": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "acme",
      "type": "team"
    }
  }
}

エンタープライズアカウントメンバーの更新

エンタープライズアカウントのメンバーを更新します。

PATCH /enterprise-accounts/{enterprise_account_id_or_name}/members/{enterprise_account_member_email_or_id}

必須パラメータ

名前	型	説明	例
permissions	配列	エンタープライズアカウントのアクセス許可	`["view"]`

curl の例

$ curl -n -X PATCH https://api.heroku.com/enterprise-accounts/$ENTERPRISE_ACCOUNT_ID_OR_NAME/members/$ENTERPRISE_ACCOUNT_MEMBER_EMAIL_OR_ID \
  -d '{
  "permissions": [
    "view"
  ]
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "enterprise_account": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  },
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "permissions": [
    {
      "description": "View enterprise account members and teams.",
      "name": "view"
    }
  ],
  "user": {
    "email": "username@example.com",
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "two_factor_authentication": true,
  "identity_provider": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "acme",
    "redacted": false,
    "owner": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "acme",
      "type": "team"
    }
  }
}

エンタープライズアカウントメンバーの削除

エンタープライズアカウントのメンバーを削除します。

DELETE /enterprise-accounts/{enterprise_account_id_or_name}/members/{enterprise_account_member_email_or_id}

curl の例

$ curl -n -X DELETE https://api.heroku.com/enterprise-accounts/$ENTERPRISE_ACCOUNT_ID_OR_NAME/members/$ENTERPRISE_ACCOUNT_MEMBER_EMAIL_OR_ID \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "enterprise_account": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  },
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "permissions": [
    {
      "description": "View enterprise account members and teams.",
      "name": "view"
    }
  ],
  "user": {
    "email": "username@example.com",
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "two_factor_authentication": true,
  "identity_provider": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "acme",
    "redacted": false,
    "owner": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "acme",
      "type": "team"
    }
  }
}

エンタープライズアカウントの毎月の使用状況

安定性: 開発

毎月の解像度でのエンタープライズアカウントの使用状況。

属性

名前	型	説明	例
addons	数値	使用されている合計アドオンクレジット	`250.0`
connect	数値	同期された Connect 行の最大数	`15000`
data	数値	ファーストパーティのアドオンに使用されている合計アドオンクレジット	`34.89`
dynos	数値	使用されている dyno の数	`1.548`
id	UUID	エンタープライズアカウントの識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
month	文字列	使用状況の年と月パターン: `^[0-9]{4}-[0-9]{2}$`	`"2019-01"`
name	文字列	エンタープライズアカウントの名前	`"example-co"`
partner	数値	サードパーティのアドオンに使用されている合計アドオンクレジット	`12.34`
space	数値	使用されている Space クレジット	`1.548`
teams/addons	数値	使用されている合計アドオンクレジット	`250.0`
teams/apps	配列	チームでのアプリの使用状況	`[{"addons":250.0,"app_name":"example","data":34.89,"dynos":1.548,"partner":12.34}]`
teams/connect	数値	同期された Connect 行の最大数	`15000`
teams/data	数値	ファーストパーティのアドオンに使用されている合計アドオンクレジット	`34.89`
teams/dynos	数値	使用されている dyno の数	`1.548`
teams/id	UUID	チームの識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
teams/name	文字列	チームの名前	`"ops"`
teams/partner	数値	サードパーティのアドオンに使用されている合計アドオンクレジット	`12.34`
teams/space	数値	使用されている Space クレジット	`1.548`

エンタープライズアカウントの毎月の使用状況の情報

月数の範囲でのエンタープライズアカウントの使用状況を取得します。開始日と終了日は、YYYY-MM の日付形式を使用してクエリパラメータとして指定できます。終了日が指定されない場合は、1 か月の使用状況が返されます。エンタープライズアカウントの識別子については、エンタープライズアカウントの一覧を参照してください。

GET /enterprise-accounts/{enterprise_account_id}/usage/monthly

必須パラメータ

名前	型	説明	例
start	文字列	範囲の開始日パターン: `^[0-9]{4}-[0-9]{2}$`	`"2019-01"`

オプションパラメータ

名前	型	説明	例
end	文字列	範囲の終了日パターン: `^[0-9]{4}-[0-9]{2}$`	`"2019-02"`

curl の例

$ curl -n https://api.heroku.com/enterprise-accounts/$ENTERPRISE_ACCOUNT_ID/usage/monthly \
 -G \
  -d start=2019-01 \
  -d end=2019-02 \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "addons": 250.0,
    "teams": [
      {
        "addons": 250.0,
        "apps": [
          {
            "addons": 250.0,
            "app_name": "example",
            "data": 34.89,
            "dynos": 1.548,
            "partner": 12.34
          }
        ],
        "connect": 15000,
        "data": 34.89,
        "dynos": 1.548,
        "id": "01234567-89ab-cdef-0123-456789abcdef",
        "name": "ops",
        "partner": 12.34,
        "space": 1.548
      }
    ],
    "connect": 15000,
    "data": 34.89,
    "dynos": 1.548,
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "month": "2019-01",
    "name": "example-co",
    "partner": 12.34,
    "space": 1.548
  }
]

フィルター

安定性: 開発

フィルターは、実行されるリクエストの数を削減するために、消費するリソースのサブセットを API コンシューマーが指定できるようにするための特殊なエンドポイントです。各フィルターエンドポイントは、それぞれでサポートされるリクエスト形式を特定する役割を果たします。これらのエンドポイントは、リクエスト URI のクエリ長の制限に達することなく大きなリクエスト本体を処理するために POST 経由ですが、リクエスト自体はべき等であり、副作用はありません。

アプリのフィルター処理

アプリ ID でフィルター処理されたアプリの一覧を要求します。

Range ヘッダーの容認可能な順序の値は id、name または updated_at です。

POST /filters/apps

curl の例

$ curl -n -X POST https://api.heroku.com/filters/apps \
  -d '{
  "in": {
    "id": [
      "01234567-89ab-cdef-0123-456789abcdef"
    ]
  }
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: id, name, updated_at
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "archived_at": "2012-01-01T12:00:00Z",
    "buildpack_provided_description": "Ruby/Rack",
    "build_stack": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "heroku-18"
    },
    "created_at": "2012-01-01T12:00:00Z",
    "git_url": "https://git.heroku.com/example.git",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "internal_routing": false,
    "joined": false,
    "locked": false,
    "maintenance": false,
    "name": "example",
    "team": {
      "name": "example"
    },
    "owner": {
      "email": "username@example.com",
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    },
    "region": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "us"
    },
    "released_at": "2012-01-01T12:00:00Z",
    "repo_size": 0,
    "slug_size": 0,
    "space": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "nasa"
    },
    "stack": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "heroku-18"
    },
    "updated_at": "2012-01-01T12:00:00Z",
    "web_url": "https://example.herokuapp.com/"
  }
]

フォーメーション

安定性: 本番環境

アプリに対して保持するプロセスのフォーメーション。プロセスをスケーリングするか、または dyno サイズを変更するようにフォーメーションを更新します。使用可能なプロセスタイプ名とコマンドは、アプリで現在リリースされている slug の process_types 属性によって定義されます。

属性

名前	型	説明	例
app:id	UUID	一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
app:name	文字列	アプリの名前パターン: `^[a-z][a-z0-9-]{1,28}[a-z0-9]$`	`"example"`
command	文字列	このプロセスを起動するために使用するコマンド	`"bundle exec rails server -p $PORT"`
created_at	日時	プロセスタイプが作成された日時	`"2012-01-01T12:00:00Z"`
dyno_size:id	UUID	dyno サイズの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
dyno_size:name	文字列	dyno サイズの名前	`"eco"`
id	UUID	このプロセスタイプの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
quantity	整数	保持するプロセスの数	`1`
size	文字列	非推奨。代わりに ‘dyno_size’ を参照してください	`"standard-1X"`
type	文字列	保持するプロセスのタイプパターン: `^[-\w]{1,128}$`	`"web"`
updated_at	日時	dyno タイプが更新された日時	`"2012-01-01T12:00:00Z"`

フォーメーションの情報

プロセスタイプに関する情報

GET /apps/{app_id_or_name}/formation/{formation_id_or_type}

curl の例

$ curl -n https://api.heroku.com/apps/$APP_ID_OR_NAME/formation/$FORMATION_ID_OR_TYPE \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "app": {
    "name": "example",
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "command": "bundle exec rails server -p $PORT",
  "created_at": "2012-01-01T12:00:00Z",
  "dyno_size": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "eco"
  },
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "quantity": 1,
  "size": "standard-1X",
  "type": "web",
  "updated_at": "2012-01-01T12:00:00Z"
}

フォーメーションの一覧

プロセスタイプのフォーメーションを一覧表示します。

Range ヘッダーの容認可能な順序の値は id または type です。

GET /apps/{app_id_or_name}/formation

curl の例

$ curl -n https://api.heroku.com/apps/$APP_ID_OR_NAME/formation \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: id, type
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "app": {
      "name": "example",
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    },
    "command": "bundle exec rails server -p $PORT",
    "created_at": "2012-01-01T12:00:00Z",
    "dyno_size": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "eco"
    },
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "quantity": 1,
    "size": "standard-1X",
    "type": "web",
    "updated_at": "2012-01-01T12:00:00Z"
  }
]

フォーメーションのバッチ更新

プロセスタイプをバッチ更新します。

PATCH /apps/{app_id_or_name}/formation

必須パラメータ

名前	型	説明	例
updates	配列	フォーメーションの更新を含む配列。各要素には更新されるプロセスタイプの “type"、ID、または名前が含まれている必要があり、オプションでその "quantity” または “size” を更新できます。	`[{"dyno_size":{"id":"01234567-89ab-cdef-0123-456789abcdef"},"quantity":1,"type":"web"}]`

curl の例

$ curl -n -X PATCH https://api.heroku.com/apps/$APP_ID_OR_NAME/formation \
  -d '{
  "updates": [
    {
      "dyno_size": {
        "id": "01234567-89ab-cdef-0123-456789abcdef"
      },
      "quantity": 1,
      "type": "web"
    }
  ]
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "app": {
      "name": "example",
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    },
    "command": "bundle exec rails server -p $PORT",
    "created_at": "2012-01-01T12:00:00Z",
    "dyno_size": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "eco"
    },
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "quantity": 1,
    "size": "standard-1X",
    "type": "web",
    "updated_at": "2012-01-01T12:00:00Z"
  }
]

フォーメーションの更新

プロセスタイプを更新します。

PATCH /apps/{app_id_or_name}/formation/{formation_id_or_type}

オプションパラメータ

名前	型	説明	例
dyno_size:id	UUID	dyno サイズの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
dyno_size:name	文字列	dyno サイズの名前	`"Standard-1X"`
quantity	整数	保持するプロセスの数	`1`

curl の例

$ curl -n -X PATCH https://api.heroku.com/apps/$APP_ID_OR_NAME/formation/$FORMATION_ID_OR_TYPE \
  -d '{
  "dyno_size": {
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "quantity": 1
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "app": {
    "name": "example",
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "command": "bundle exec rails server -p $PORT",
  "created_at": "2012-01-01T12:00:00Z",
  "dyno_size": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "eco"
  },
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "quantity": 1,
  "size": "standard-1X",
  "type": "web",
  "updated_at": "2012-01-01T12:00:00Z"
}

世代

安定性: プロトタイプ

世代は、アプリの実行環境、ルーティング、テレメトリー、ビルドシステムを含む Heroku プラットフォームのバージョンを表します。

属性

名前	型	説明	例
created_at	日時	世代が作成された日時	`"2024-12-01T12:00:00Z"`
id	UUID	世代の一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
name	文字列	世代の一意の名前	`"fir"`
updated_at	日時	世代が更新された日時	`"2024-12-01T12:00:00Z"`

世代の情報

世代に関する情報。

GET /generations/{stack_name_or_id}

curl の例

$ curl -n https://api.heroku.com/generations/$STACK_NAME_OR_ID \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "created_at": "2024-12-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "name": "fir",
  "updated_at": "2024-12-01T12:00:00Z"
}

世代の一覧

利用可能な世代を一覧表示します。

Range ヘッダーの容認可能な順序の値は id または name です。

GET /generations

curl の例

$ curl -n https://api.heroku.com/generations \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: id, name
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "created_at": "2024-12-01T12:00:00Z",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "fir",
    "updated_at": "2024-12-01T12:00:00Z"
  }
]

チームごとの世代の一覧

チームで利用可能な世代を一覧表示します。

Range ヘッダーの容認可能な順序の値は id または name です。

GET /teams/{team_name_or_id}/available-generations

curl の例

$ curl -n https://api.heroku.com/teams/$TEAM_NAME_OR_ID/available-generations \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: id, name
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "created_at": "2024-12-01T12:00:00Z",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "fir",
    "updated_at": "2024-12-01T12:00:00Z"
  }
]

ID プロバイダー

安定性: 本番環境

ID プロバイダーは、チームまたはエンタープライズアカウントの SAML 設定を表します。

属性

名前	型	説明	例
certificate	文字列	パブリック証明書の生のコンテンツ (.crt または .pem ファイルなど)	`"-----BEGIN CERTIFICATE----- ..."`
created_at	日時	プロバイダーレコードが作成された日時	`"2012-01-01T12:00:00Z"`
entity_id	文字列	ID プロバイダーによって提供される URL 識別子	`"https://customer-domain.idp.com"`
id	UUID	この ID プロバイダーの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
organization	null 許容オブジェクト	この ID プロバイダーに関連付けられているチーム	`null`
organization:name	文字列	チームの一意の名前	`"example"`
owner:id	UUID	所有者の一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
owner:name	文字列	所有者の名前	`"acme"`
owner:type	文字列	所有者のタイプ次のうちのいずれか: `"team"`、`"enterprise-account"`	`"team"`
slo_target_url	文字列	この ID プロバイダーのシングルログアウト URL	`"https://example.com/idp/logout"`
sso_target_url	文字列	この ID プロバイダーのシングルサインオン URL	`"https://example.com/idp/login"`
updated_at	日時	ID プロバイダーレコードが更新された日時	`"2012-01-01T12:00:00Z"`

チームごとの ID プロバイダーの一覧

チームの ID プロバイダーの一覧を取得します。

GET /teams/{team_name}/identity-providers

curl の例

$ curl -n https://api.heroku.com/teams/$TEAM_NAME/identity-providers \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "certificate": "-----BEGIN CERTIFICATE----- ...",
    "created_at": "2012-01-01T12:00:00Z",
    "entity_id": "https://customer-domain.idp.com",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "slo_target_url": "https://example.com/idp/logout",
    "sso_target_url": "https://example.com/idp/login",
    "organization": {
      "name": "example"
    },
    "updated_at": "2012-01-01T12:00:00Z",
    "owner": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "acme",
      "type": "team"
    }
  }
]

チームごとの ID プロバイダーの作成

チームの ID プロバイダーを作成します。

POST /teams/{team_name}/identity-providers

必須パラメータ

名前	型	説明	例
certificate	文字列	パブリック証明書の生のコンテンツ (.crt または .pem ファイルなど)	`"-----BEGIN CERTIFICATE----- ..."`
entity_id	文字列	ID プロバイダーによって提供される URL 識別子	`"https://customer-domain.idp.com"`
sso_target_url	文字列	この ID プロバイダーのシングルサインオン URL	`"https://example.com/idp/login"`

オプションパラメータ

名前	型	説明	例
slo_target_url	文字列	この ID プロバイダーのシングルログアウト URL	`"https://example.com/idp/logout"`

curl の例

$ curl -n -X POST https://api.heroku.com/teams/$TEAM_NAME/identity-providers \
  -d '{
  "certificate": "-----BEGIN CERTIFICATE----- ...",
  "entity_id": "https://customer-domain.idp.com",
  "slo_target_url": "https://example.com/idp/logout",
  "sso_target_url": "https://example.com/idp/login"
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 201 Created
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "certificate": "-----BEGIN CERTIFICATE----- ...",
  "created_at": "2012-01-01T12:00:00Z",
  "entity_id": "https://customer-domain.idp.com",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "slo_target_url": "https://example.com/idp/logout",
  "sso_target_url": "https://example.com/idp/login",
  "organization": {
    "name": "example"
  },
  "updated_at": "2012-01-01T12:00:00Z",
  "owner": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "acme",
    "type": "team"
  }
}

チームごとの ID プロバイダーの更新

チームの ID プロバイダーを更新します。

PATCH /teams/{team_name}/identity-providers/{identity_provider_id}

オプションパラメータ

名前	型	説明	例
certificate	文字列	パブリック証明書の生のコンテンツ (.crt または .pem ファイルなど)	`"-----BEGIN CERTIFICATE----- ..."`
entity_id	文字列	ID プロバイダーによって提供される URL 識別子	`"https://customer-domain.idp.com"`
slo_target_url	文字列	この ID プロバイダーのシングルログアウト URL	`"https://example.com/idp/logout"`
sso_target_url	文字列	この ID プロバイダーのシングルサインオン URL	`"https://example.com/idp/login"`

curl の例

$ curl -n -X PATCH https://api.heroku.com/teams/$TEAM_NAME/identity-providers/$IDENTITY_PROVIDER_ID \
  -d '{
  "certificate": "-----BEGIN CERTIFICATE----- ...",
  "entity_id": "https://customer-domain.idp.com",
  "slo_target_url": "https://example.com/idp/logout",
  "sso_target_url": "https://example.com/idp/login"
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "certificate": "-----BEGIN CERTIFICATE----- ...",
  "created_at": "2012-01-01T12:00:00Z",
  "entity_id": "https://customer-domain.idp.com",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "slo_target_url": "https://example.com/idp/logout",
  "sso_target_url": "https://example.com/idp/login",
  "organization": {
    "name": "example"
  },
  "updated_at": "2012-01-01T12:00:00Z",
  "owner": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "acme",
    "type": "team"
  }
}

チームごとの ID プロバイダーの削除

チームの ID プロバイダーを削除します。

DELETE /teams/{team_name}/identity-providers/{identity_provider_id}

curl の例

$ curl -n -X DELETE https://api.heroku.com/teams/$TEAM_NAME/identity-providers/$IDENTITY_PROVIDER_ID \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "certificate": "-----BEGIN CERTIFICATE----- ...",
  "created_at": "2012-01-01T12:00:00Z",
  "entity_id": "https://customer-domain.idp.com",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "slo_target_url": "https://example.com/idp/logout",
  "sso_target_url": "https://example.com/idp/login",
  "organization": {
    "name": "example"
  },
  "updated_at": "2012-01-01T12:00:00Z",
  "owner": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "acme",
    "type": "team"
  }
}

インバウンドルールセット

安定性: プロトタイプ

インバウンドルールセットは、アプリケーションに接続できるホスト、または接続できないホストを指定するルールのコレクションです。

属性

名前	型	説明	例
created_at	日時	インバウンドルールセットが作成された日時	`"2012-01-01T12:00:00Z"`
created_by	メール	一意のメールアドレス	`"username@example.com"`
id	UUID	インバウンドルールセットの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
rules	配列		`[{"action":"allow","source":"1.1.1.1/1"}]`
space:id	UUID	Space の一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
space:name	文字列	Space の一意の名前パターン: `^[a-z0-9](?:[a-z0-9]\|-(?!-))+[a-z0-9]$`	`"nasa"`

現在のインバウンドルールセット

Space の現在のインバウンドルールセット

GET /spaces/{space_id_or_name}/inbound-ruleset

curl の例

$ curl -n https://api.heroku.com/spaces/$SPACE_ID_OR_NAME/inbound-ruleset \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "space": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "nasa"
  },
  "created_at": "2012-01-01T12:00:00Z",
  "rules": [
    {
      "action": "allow",
      "source": "1.1.1.1/1"
    }
  ],
  "created_by": "username@example.com"
}

インバウンドルールセットの情報

既存のインバウンドルールセットに関する情報

GET /spaces/{space_id_or_name}/inbound-rulesets/{inbound_ruleset_id}

curl の例

$ curl -n https://api.heroku.com/spaces/$SPACE_ID_OR_NAME/inbound-rulesets/$INBOUND_RULESET_ID \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "space": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "nasa"
  },
  "created_at": "2012-01-01T12:00:00Z",
  "rules": [
    {
      "action": "allow",
      "source": "1.1.1.1/1"
    }
  ],
  "created_by": "username@example.com"
}

インバウンドルールセットの一覧

Space のすべてのインバウンドルールセットを一覧表示します。

Range ヘッダーの唯一の容認可能な順序の値は id です。

GET /spaces/{space_id_or_name}/inbound-rulesets

curl の例

$ curl -n https://api.heroku.com/spaces/$SPACE_ID_OR_NAME/inbound-rulesets \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: id
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "space": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "nasa"
    },
    "created_at": "2012-01-01T12:00:00Z",
    "rules": [
      {
        "action": "allow",
        "source": "1.1.1.1/1"
      }
    ],
    "created_by": "username@example.com"
  }
]

インバウンドルールセットの作成

新しいインバウンドルールセットを作成します。

PUT /spaces/{space_id_or_name}/inbound-ruleset

オプションパラメータ

名前	型	説明	例
rules	配列		`[{"action":"allow","source":"1.1.1.1/1"}]`

curl の例

$ curl -n -X PUT https://api.heroku.com/spaces/$SPACE_ID_OR_NAME/inbound-ruleset \
  -d '{
  "rules": [
    {
      "action": "allow",
      "source": "1.1.1.1/1"
    }
  ]
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 201 Created
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "space": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "nasa"
  },
  "created_at": "2012-01-01T12:00:00Z",
  "rules": [
    {
      "action": "allow",
      "source": "1.1.1.1/1"
    }
  ],
  "created_by": "username@example.com"
}

請求書

安定性: 開発

請求書は、価格設定と料金が含まれている、アカウントに対する商品の請求明細書です。

属性

名前	型	説明	例
charges_total	数値	この請求書での合計料金	`100.0`
created_at	日時	請求書が作成された日時	`"2012-01-01T12:00:00Z"`
credits_total	数値	この請求書での合計クレジット	`100.0`
id	UUID	この請求書の一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
number	整数	人間に解読可能な請求書番号	`9403943`
period_end	文字列	この請求書に含まれている終了日	`"01/31/2014"`
period_start	文字列	この請求書に含まれている開始日	`"01/01/2014"`
state	整数	この請求書の支払ステータス (保留中、成功、失敗)	`1`
total	数値	この請求書での料金とクレジットの組み合わせ合計	`100.0`
updated_at	日時	請求書が更新された日時	`"2012-01-01T12:00:00Z"`

請求書の情報

既存の請求書に関する情報。

GET /account/invoices/{invoice_number}

curl の例

$ curl -n https://api.heroku.com/account/invoices/$INVOICE_NUMBER \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "charges_total": 100.0,
  "created_at": "2012-01-01T12:00:00Z",
  "credits_total": 100.0,
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "number": 9403943,
  "period_end": "01/31/2014",
  "period_start": "01/01/2014",
  "state": 1,
  "total": 100.0,
  "updated_at": "2012-01-01T12:00:00Z"
}

請求書の一覧

既存の請求書を一覧表示します。

Range ヘッダーの唯一の容認可能な順序の値は number です。

GET /account/invoices

curl の例

$ curl -n https://api.heroku.com/account/invoices \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: number
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "charges_total": 100.0,
    "created_at": "2012-01-01T12:00:00Z",
    "credits_total": 100.0,
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "number": 9403943,
    "period_end": "01/31/2014",
    "period_start": "01/01/2014",
    "state": 1,
    "total": 100.0,
    "updated_at": "2012-01-01T12:00:00Z"
  }
]

請求書の住所

安定性: 開発

請求書の住所は、請求書に関して一覧表示する住所を表します。

属性

名前	型	説明	例
address_1	文字列	請求書の住所 1	`"40 Hickory Blvd."`
address_2	文字列	請求書の住所 2	`"Suite 300"`
city	文字列	請求書の市	`"Seattle"`
country	文字列	国	`"US"`
heroku_id	文字列	heroku_id 識別子の参照	`"user930223902@heroku.com"`
other	文字列	請求書に記載されるメタデータ/追加情報	`"Company ABC Inc. VAT 903820"`
postal_code	文字列	請求書の郵便番号	`"98101"`
state	文字列	請求書の州	`"WA"`
use_invoice_address	ブール値	請求書の住所をアカウントに使用するかどうかを示すフラグ	`true`

請求書の住所の情報

既存の請求書の住所を取得します。

GET /account/invoice-address

curl の例

$ curl -n https://api.heroku.com/account/invoice-address \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "address_1": "40 Hickory Blvd.",
  "address_2": "Suite 300",
  "city": "Seattle",
  "country": "US",
  "heroku_id": "user930223902@heroku.com",
  "other": "Company ABC Inc. VAT 903820",
  "postal_code": "98101",
  "state": "WA",
  "use_invoice_address": true
}

請求書の住所の更新

アカウントの請求書の住所を更新します。

PUT /account/invoice-address

オプションパラメータ

名前	型	説明	例
address_1	文字列	請求書の住所 1	`"40 Hickory Blvd."`
address_2	文字列	請求書の住所 2	`"Suite 300"`
city	文字列	請求書の市	`"Seattle"`
country	文字列	国	`"US"`
other	文字列	請求書に記載されるメタデータ/追加情報	`"Company ABC Inc. VAT 903820"`
postal_code	文字列	請求書の郵便番号	`"98101"`
state	文字列	請求書の州	`"WA"`
use_invoice_address	ブール値	請求書の住所をアカウントに使用するかどうかを示すフラグ	`true`

curl の例

$ curl -n -X PUT https://api.heroku.com/account/invoice-address \
  -d '{
  "address_1": "40 Hickory Blvd.",
  "address_2": "Suite 300",
  "city": "Seattle",
  "country": "US",
  "other": "Company ABC Inc. VAT 903820",
  "postal_code": "98101",
  "state": "WA",
  "use_invoice_address": true
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "address_1": "40 Hickory Blvd.",
  "address_2": "Suite 300",
  "city": "Seattle",
  "country": "US",
  "heroku_id": "user930223902@heroku.com",
  "other": "Company ABC Inc. VAT 903820",
  "postal_code": "98101",
  "state": "WA",
  "use_invoice_address": true
}

キー

安定性: 本番環境

キーは、アカウントに関連付けられているパブリック SSH キーを表し、Git 操作を実行するアカウントを承認するために使用されます。

属性

名前	型	説明	例
comment	文字列	キーに関するコメント	`"username@host"`
created_at	日時	キーが作成された日時	`"2012-01-01T12:00:00Z"`
email	文字列	非推奨。代わりに ‘コメント’ を参照してください。	`"username@host"`
fingerprint	文字列	内容に基づいた一意の識別文字列	`"17:63:a4:ba:24:d3:7f:af:17:c8:94:82:7e:80:56:bf"`
id	UUID	このキーの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
public_key	文字列	アップロードされる完全な public_key	`"ssh-rsa AAAAB3NzaC1ycVc/../839Uv username@example.com"`
updated_at	日時	キーが更新された日時	`"2012-01-01T12:00:00Z"`

キーの情報

既存のキーに関する情報。

GET /account/keys/{key_id_or_fingerprint}

curl の例

$ curl -n https://api.heroku.com/account/keys/$KEY_ID_OR_FINGERPRINT \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "comment": "username@host",
  "created_at": "2012-01-01T12:00:00Z",
  "email": "username@host",
  "fingerprint": "17:63:a4:ba:24:d3:7f:af:17:c8:94:82:7e:80:56:bf",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "public_key": "ssh-rsa AAAAB3NzaC1ycVc/../839Uv username@example.com",
  "updated_at": "2012-01-01T12:00:00Z"
}

キーの一覧

既存のキーを一覧表示します。

Range ヘッダーの容認可能な順序の値は fingerprint または id です。

GET /account/keys

curl の例

$ curl -n https://api.heroku.com/account/keys \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: fingerprint, id
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "comment": "username@host",
    "created_at": "2012-01-01T12:00:00Z",
    "email": "username@host",
    "fingerprint": "17:63:a4:ba:24:d3:7f:af:17:c8:94:82:7e:80:56:bf",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "public_key": "ssh-rsa AAAAB3NzaC1ycVc/../839Uv username@example.com",
    "updated_at": "2012-01-01T12:00:00Z"
  }
]

ログドレイン

安定性: 本番環境

ログドレインは、Heroku ログを長期のアーカイブのために外部の Syslog サーバーに転送するための方法を提供します。この外部サービスを、Heroku から Syslog パケットを受信するように設定する必要があります。その後、この API を使用して、その URL をアプリに追加できます。一部のアドオンは、それがアプリにプロビジョニングされときにログドレインを追加します。これらのドレインを削除するには、そのアドオンを削除するしかありません。

属性

名前	型	説明	例
addon	null 許容オブジェクト	このドレインを作成したアドオン	`{"id":"01234567-89ab-cdef-0123-456789abcdef","name":"singing-swiftly-1242","app":{"id":"01234567-89ab-cdef-0123-456789abcdef","name":"example"}}`
addon:app:id	UUID	一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
addon:app:name	文字列	アプリの名前パターン: `^[a-z][a-z0-9-]{1,28}[a-z0-9]$`	`"example"`
addon:id	UUID	一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
addon:name	文字列	アドオンのグローバル名パターン: `^[a-zA-Z][A-Za-z0-9_-]+$`	`"acme-inc-primary-database"`
app	null 許容オブジェクト	このドレインにアタッチされたアプリケーション	`{"id":"01234567-89ab-cdef-0123-456789abcdef","name":"example"}`
app:id	UUID	一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
app:name	文字列	アプリの名前パターン: `^[a-z][a-z0-9-]{1,28}[a-z0-9]$`	`"example"`
created_at	日時	ログドレインが作成された日時	`"2012-01-01T12:00:00Z"`
id	UUID	このログドレインの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
token	文字列	ログドレインに関連付けられているトークン	`"d.01234567-89ab-cdef-0123-456789abcdef"`
updated_at	日時	ログドレインが更新された日時	`"2012-01-01T12:00:00Z"`
url	文字列	ログドレインに関連付けられている URL	`"https://example.com/drain"`

ログドレインの作成

新しいログドレインを作成します。

POST /apps/{app_id_or_name}/log-drains

必須パラメータ

名前	型	説明	例
url	文字列	ログドレインに関連付けられている URL	`"https://example.com/drain"`

curl の例

$ curl -n -X POST https://api.heroku.com/apps/$APP_ID_OR_NAME/log-drains \
  -d '{
  "url": "https://example.com/drain"
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 201 Created
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "addon": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "singing-swiftly-1242",
    "app": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "example"
    }
  },
  "app": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  },
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "token": "d.01234567-89ab-cdef-0123-456789abcdef",
  "updated_at": "2012-01-01T12:00:00Z",
  "url": "https://example.com/drain"
}

ログドレインの更新

アドオンによって所有されているログドレインを更新します。

PUT /addons/{add_on_id_or_name}/log-drains/{log_drain_id_or_url_or_token}

必須パラメータ

名前	型	説明	例
url	文字列	ログドレインに関連付けられている URL	`"https://example.com/drain"`

curl の例

$ curl -n -X PUT https://api.heroku.com/addons/$ADD_ON_ID_OR_NAME/log-drains/$LOG_DRAIN_ID_OR_URL_OR_TOKEN \
  -d '{
  "url": "https://example.com/drain"
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "addon": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "singing-swiftly-1242",
    "app": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "example"
    }
  },
  "app": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  },
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "token": "d.01234567-89ab-cdef-0123-456789abcdef",
  "updated_at": "2012-01-01T12:00:00Z",
  "url": "https://example.com/drain"
}

ログドレインの削除

既存のログドレインを削除します。アドオンによって追加されたログドレインを削除するには、そのアドオンを削除するしかありません。

DELETE /apps/{app_id_or_name}/log-drains/{log_drain_id_or_url_or_token}

curl の例

$ curl -n -X DELETE https://api.heroku.com/apps/$APP_ID_OR_NAME/log-drains/$LOG_DRAIN_ID_OR_URL_OR_TOKEN \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "addon": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "singing-swiftly-1242",
    "app": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "example"
    }
  },
  "app": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  },
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "token": "d.01234567-89ab-cdef-0123-456789abcdef",
  "updated_at": "2012-01-01T12:00:00Z",
  "url": "https://example.com/drain"
}

ログドレインの情報

既存のログドレインに関する情報。

GET /apps/{app_id_or_name}/log-drains/{log_drain_id_or_url_or_token}

curl の例

$ curl -n https://api.heroku.com/apps/$APP_ID_OR_NAME/log-drains/$LOG_DRAIN_ID_OR_URL_OR_TOKEN \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "addon": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "singing-swiftly-1242",
    "app": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "example"
    }
  },
  "app": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  },
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "token": "d.01234567-89ab-cdef-0123-456789abcdef",
  "updated_at": "2012-01-01T12:00:00Z",
  "url": "https://example.com/drain"
}

アドオンごとのログドレインの一覧

アドオンの既存のログドレインを一覧表示します。

Range ヘッダーの唯一の容認可能な順序の値は url です。

GET /addons/{add_on_id_or_name}/log-drains

curl の例

$ curl -n https://api.heroku.com/addons/$ADD_ON_ID_OR_NAME/log-drains \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: url
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "addon": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "singing-swiftly-1242",
      "app": {
        "id": "01234567-89ab-cdef-0123-456789abcdef",
        "name": "example"
      }
    },
    "app": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "example"
    },
    "created_at": "2012-01-01T12:00:00Z",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "token": "d.01234567-89ab-cdef-0123-456789abcdef",
    "updated_at": "2012-01-01T12:00:00Z",
    "url": "https://example.com/drain"
  }
]

ログドレインの一覧

既存のログドレインを一覧表示します。

Range ヘッダーの唯一の容認可能な順序の値は url です。

GET /apps/{app_id_or_name}/log-drains

curl の例

$ curl -n https://api.heroku.com/apps/$APP_ID_OR_NAME/log-drains \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: url
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "addon": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "singing-swiftly-1242",
      "app": {
        "id": "01234567-89ab-cdef-0123-456789abcdef",
        "name": "example"
      }
    },
    "app": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "example"
    },
    "created_at": "2012-01-01T12:00:00Z",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "token": "d.01234567-89ab-cdef-0123-456789abcdef",
    "updated_at": "2012-01-01T12:00:00Z",
    "url": "https://example.com/drain"
  }
]

ログセッション

安定性: 本番環境

ログセッションは、アプリの HTTP ベースのログストリームへの参照です。

属性

名前	型	説明	例
created_at	日時	ログ接続が作成された日時	`"2012-01-01T12:00:00Z"`
id	UUID	このログセッションの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
logplex_url	文字列	ログストリーミングセッションのための URL	`"https://logplex.heroku.com/sessions/01234567-89ab-cdef-0123-456789abcdef?srv=1325419200"`
updated_at	日時	ログセッションが更新された日時	`"2012-01-01T12:00:00Z"`

ログセッションの作成

新しいログセッションを作成します。

POST /apps/{app_id_or_name}/log-sessions

オプションパラメータ

名前	型	説明	例
dyno_name	文字列	結果を絞り込むための dyno 名	`"'web.1' (Cedar-generation) or 'web-1234abcde-123ab' (Fir-generation)"`
lines	整数	一度にストリーミングするログ行の数	`10`
source	文字列	結果を制限するための出力先のログソース	`"app"`
tail	ブール値	進行中のログをストリーミングするかどうか	`true`
type	文字列	結果を絞り込むためのプロセスタイプ	`"web"`

curl の例

$ curl -n -X POST https://api.heroku.com/apps/$APP_ID_OR_NAME/log-sessions \
  -d '{
  "dyno_name": "'web.1' (Cedar-generation) or 'web-1234abcde-123ab' (Fir-generation)",
  "type": "web",
  "lines": 10,
  "source": "app",
  "tail": true
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 201 Created
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "logplex_url": "https://logplex.heroku.com/sessions/01234567-89ab-cdef-0123-456789abcdef?srv=1325419200",
  "updated_at": "2012-01-01T12:00:00Z"
}

OAuth 認証

安定性: 本番環境

OAuth 認証は、プラットフォームの使用を自動化、カスタマイズ、または拡張するために Heroku ユーザーが認証しているクライアントを表します。詳細は、Heroku OAuth のドキュメントを参照してください。

属性

名前	型	説明	例
access_token	null 許容オブジェクト	この認証のアクセストークン	`null`
access_token:expires_in	null 許容整数	OAuth トークンが期限切れになるまでの秒数。有効期間が無期限のトークンでは `null` になることがあります。	`2592000`
access_token:id	UUID	OAuth トークンの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
access_token:token	文字列	認証に使用されるトークンのコンテンツ	`"HRKU-01234567-89ab-cdef-0123-456789abcdef"`
client	null 許容オブジェクト	この認証を取得したクライアントの識別子 (存在する場合)	`null`
client:id	UUID	この OAuth クライアントの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
client:name	文字列	OAuth クライアントの名前	`"example"`
client:redirect_uri	文字列	OAuth クライアントの認証後のリダイレクト用のエンドポイント	`"https://example.com/auth/heroku/callback"`
created_at	日時	OAuth 認証が作成された日時	`"2012-01-01T12:00:00Z"`
description	文字列	この OAuth 認証の人間が理解できる説明	`"sample authorization"`
grant	null 許容オブジェクト	この認証の許可	`null`
grant:code	文字列	OAuth Web アプリケーション認証から受信された許可コード	`"01234567-89ab-cdef-0123-456789abcdef"`
grant:expires_in	整数	OAuth 許可が期限切れになるまでの秒数	`2592000`
grant:id	UUID	OAuth 許可の一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
id	UUID	OAuth 認証の一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
refresh_token	null 許容オブジェクト	この認証の更新トークン	`null`
refresh_token:expires_in	null 許容整数	OAuth トークンが期限切れになるまでの秒数。有効期間が無期限のトークンでは `null` になることがあります。	`2592000`
refresh_token:id	UUID	OAuth トークンの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
refresh_token:token	文字列	認証に使用されるトークンのコンテンツ	`"HRKU-01234567-89ab-cdef-0123-456789abcdef"`
scope	配列	OAuth 認証によって許可されるアクセスのスコープ	`["global"]`
session	null 許容オブジェクト	この認証のセッション	`null`
session:id	UUID	OAuth トークンの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
updated_at	日時	OAuth 認証が更新された日時	`"2012-01-01T12:00:00Z"`
user:email	メール	一意のメールアドレス	`"username@example.com"`
user:full_name	null 許容文字列	アカウント所有者のフルネーム	`"Tina Edmonds"`
user:id	UUID	アカウントの識別子	`"01234567-89ab-cdef-0123-456789abcdef"`

OAuth 認証の作成

新しい OAuth 認証を作成します。

POST /oauth/authorizations

必須パラメータ

名前	型	説明	例
scope	配列	OAuth 認証によって許可されるアクセスのスコープ	`["global"]`

オプションパラメータ

名前	型	説明	例
client	文字列	この OAuth クライアントの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
description	文字列	この OAuth 認証の人間が理解できる説明	`"sample authorization"`
expires_in	null 許容整数	OAuth トークンが期限切れになるまでの秒数。有効期間が無期限のトークンでは `null` になることがあります。	`2592000`

curl の例

$ curl -n -X POST https://api.heroku.com/oauth/authorizations \
  -d '{
  "client": "01234567-89ab-cdef-0123-456789abcdef",
  "description": "sample authorization",
  "expires_in": 2592000,
  "scope": [
    "global"
  ]
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 201 Created
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "access_token": {
    "expires_in": 2592000,
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "token": "HRKU-01234567-89ab-cdef-0123-456789abcdef"
  },
  "client": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example",
    "redirect_uri": "https://example.com/auth/heroku/callback"
  },
  "created_at": "2012-01-01T12:00:00Z",
  "description": "sample authorization",
  "grant": {
    "code": "01234567-89ab-cdef-0123-456789abcdef",
    "expires_in": 2592000,
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "refresh_token": {
    "expires_in": 2592000,
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "token": "HRKU-01234567-89ab-cdef-0123-456789abcdef"
  },
  "scope": [
    "global"
  ],
  "session": {
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "updated_at": "2012-01-01T12:00:00Z",
  "user": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "email": "username@example.com",
    "full_name": "Tina Edmonds"
  }
}

OAuth 認証の削除

OAuth 認証を削除します。

DELETE /oauth/authorizations/{oauth_authorization_id}

curl の例

$ curl -n -X DELETE https://api.heroku.com/oauth/authorizations/$OAUTH_AUTHORIZATION_ID \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "access_token": {
    "expires_in": 2592000,
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "token": "HRKU-01234567-89ab-cdef-0123-456789abcdef"
  },
  "client": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example",
    "redirect_uri": "https://example.com/auth/heroku/callback"
  },
  "created_at": "2012-01-01T12:00:00Z",
  "description": "sample authorization",
  "grant": {
    "code": "01234567-89ab-cdef-0123-456789abcdef",
    "expires_in": 2592000,
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "refresh_token": {
    "expires_in": 2592000,
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "token": "HRKU-01234567-89ab-cdef-0123-456789abcdef"
  },
  "scope": [
    "global"
  ],
  "session": {
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "updated_at": "2012-01-01T12:00:00Z",
  "user": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "email": "username@example.com",
    "full_name": "Tina Edmonds"
  }
}

OAuth 認証の情報

OAuth 認証に関する情報。

GET /oauth/authorizations/{oauth_authorization_id}

curl の例

$ curl -n https://api.heroku.com/oauth/authorizations/$OAUTH_AUTHORIZATION_ID \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "access_token": {
    "expires_in": 2592000,
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "token": "HRKU-01234567-89ab-cdef-0123-456789abcdef"
  },
  "client": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example",
    "redirect_uri": "https://example.com/auth/heroku/callback"
  },
  "created_at": "2012-01-01T12:00:00Z",
  "description": "sample authorization",
  "grant": {
    "code": "01234567-89ab-cdef-0123-456789abcdef",
    "expires_in": 2592000,
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "refresh_token": {
    "expires_in": 2592000,
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "token": "HRKU-01234567-89ab-cdef-0123-456789abcdef"
  },
  "scope": [
    "global"
  ],
  "session": {
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "updated_at": "2012-01-01T12:00:00Z",
  "user": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "email": "username@example.com",
    "full_name": "Tina Edmonds"
  }
}

OAuth 認証の更新

既存の OAuth 認証を更新します。

PATCH /oauth/authorizations/{oauth_authorization_id}

必須パラメータ

名前	型	説明	例
client:id	UUID	この OAuth クライアントの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
client:secret	文字列	このクライアントで OAuth 認証を取得するために使用される秘密鍵	`"01234567-89ab-cdef-0123-456789abcdef"`

オプションパラメータ

名前	型	説明	例
description	文字列	この OAuth 認証の人間が理解できる説明	`"sample authorization"`

curl の例

$ curl -n -X PATCH https://api.heroku.com/oauth/authorizations/$OAUTH_AUTHORIZATION_ID \
  -d '{
  "description": "sample authorization",
  "client": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "secret": "01234567-89ab-cdef-0123-456789abcdef"
  }
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "access_token": {
    "expires_in": 2592000,
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "token": "HRKU-01234567-89ab-cdef-0123-456789abcdef"
  },
  "client": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example",
    "redirect_uri": "https://example.com/auth/heroku/callback"
  },
  "created_at": "2012-01-01T12:00:00Z",
  "description": "sample authorization",
  "grant": {
    "code": "01234567-89ab-cdef-0123-456789abcdef",
    "expires_in": 2592000,
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "refresh_token": {
    "expires_in": 2592000,
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "token": "HRKU-01234567-89ab-cdef-0123-456789abcdef"
  },
  "scope": [
    "global"
  ],
  "session": {
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "updated_at": "2012-01-01T12:00:00Z",
  "user": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "email": "username@example.com",
    "full_name": "Tina Edmonds"
  }
}

OAuth 認証の一覧

OAuth 認証を一覧表示します。

Range ヘッダーの唯一の容認可能な順序の値は id です。

GET /oauth/authorizations

curl の例

$ curl -n https://api.heroku.com/oauth/authorizations \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: id
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "access_token": {
      "expires_in": 2592000,
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "token": "HRKU-01234567-89ab-cdef-0123-456789abcdef"
    },
    "client": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "example",
      "redirect_uri": "https://example.com/auth/heroku/callback"
    },
    "created_at": "2012-01-01T12:00:00Z",
    "description": "sample authorization",
    "grant": {
      "code": "01234567-89ab-cdef-0123-456789abcdef",
      "expires_in": 2592000,
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    },
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "refresh_token": {
      "expires_in": 2592000,
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "token": "HRKU-01234567-89ab-cdef-0123-456789abcdef"
    },
    "scope": [
      "global"
    ],
    "session": {
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    },
    "updated_at": "2012-01-01T12:00:00Z",
    "user": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "email": "username@example.com",
      "full_name": "Tina Edmonds"
    }
  }
]

OAuth 認証の再生成

OAuth トークンを再生成します。このエンドポイントは、直接承認または特権 OAuth クライアントからのみ使用できます。

POST /oauth/authorizations/{oauth_authorization_id}/actions/regenerate-tokens

curl の例

$ curl -n -X POST https://api.heroku.com/oauth/authorizations/$OAUTH_AUTHORIZATION_ID/actions/regenerate-tokens \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "access_token": {
    "expires_in": 2592000,
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "token": "HRKU-01234567-89ab-cdef-0123-456789abcdef"
  },
  "client": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example",
    "redirect_uri": "https://example.com/auth/heroku/callback"
  },
  "created_at": "2012-01-01T12:00:00Z",
  "description": "sample authorization",
  "grant": {
    "code": "01234567-89ab-cdef-0123-456789abcdef",
    "expires_in": 2592000,
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "refresh_token": {
    "expires_in": 2592000,
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "token": "HRKU-01234567-89ab-cdef-0123-456789abcdef"
  },
  "scope": [
    "global"
  ],
  "session": {
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "updated_at": "2012-01-01T12:00:00Z",
  "user": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "email": "username@example.com",
    "full_name": "Tina Edmonds"
  }
}

OAuth クライアント

安定性: 本番環境

OAuth クライアントは、プラットフォームの使用を自動化、カスタマイズ、または拡張するために Heroku ユーザーが認証できるアプリケーションです。詳細は、Heroku OAuth のドキュメントを参照してください。

属性

名前	型	説明	例
created_at	日時	OAuth クライアントが作成された日時	`"2012-01-01T12:00:00Z"`
id	UUID	この OAuth クライアントの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
ignores_delinquent	null 許容ブール値	滞納アカウントでもクライアントが引き続き操作可能かどうか	`false`
name	文字列	OAuth クライアントの名前	`"example"`
redirect_uri	文字列	OAuth クライアントの認証後のリダイレクト用のエンドポイント	`"https://example.com/auth/heroku/callback"`
secret	文字列	このクライアントで OAuth 認証を取得するために使用される秘密鍵	`"01234567-89ab-cdef-0123-456789abcdef"`
updated_at	日時	OAuth クライアントが更新された日時	`"2012-01-01T12:00:00Z"`

OAuth クライアントの作成

新しい OAuth クライアントを作成します。

POST /oauth/clients

必須パラメータ

名前	型	説明	例
name	文字列	OAuth クライアントの名前	`"example"`
redirect_uri	文字列	OAuth クライアントの認証後のリダイレクト用のエンドポイント	`"https://example.com/auth/heroku/callback"`

curl の例

$ curl -n -X POST https://api.heroku.com/oauth/clients \
  -d '{
  "name": "example",
  "redirect_uri": "https://example.com/auth/heroku/callback"
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 201 Created
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "ignores_delinquent": false,
  "name": "example",
  "redirect_uri": "https://example.com/auth/heroku/callback",
  "secret": "01234567-89ab-cdef-0123-456789abcdef",
  "updated_at": "2012-01-01T12:00:00Z"
}

OAuth クライアントの削除

OAuth クライアントを削除します。

DELETE /oauth/clients/{oauth_client_id}

curl の例

$ curl -n -X DELETE https://api.heroku.com/oauth/clients/$OAUTH_CLIENT_ID \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "ignores_delinquent": false,
  "name": "example",
  "redirect_uri": "https://example.com/auth/heroku/callback",
  "secret": "01234567-89ab-cdef-0123-456789abcdef",
  "updated_at": "2012-01-01T12:00:00Z"
}

OAuth クライアントの情報

OAuth クライアントに関する情報。認証されていないリクエストの出力には、secret パラメータは含まれません。

GET /oauth/clients/{oauth_client_id}

curl の例

$ curl -n https://api.heroku.com/oauth/clients/$OAUTH_CLIENT_ID \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "ignores_delinquent": false,
  "name": "example",
  "redirect_uri": "https://example.com/auth/heroku/callback",
  "secret": "01234567-89ab-cdef-0123-456789abcdef",
  "updated_at": "2012-01-01T12:00:00Z"
}

OAuth クライアントの一覧

OAuth クライアントを一覧表示します。

Range ヘッダーの唯一の容認可能な順序の値は id です。

GET /oauth/clients

curl の例

$ curl -n https://api.heroku.com/oauth/clients \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: id
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "created_at": "2012-01-01T12:00:00Z",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "ignores_delinquent": false,
    "name": "example",
    "redirect_uri": "https://example.com/auth/heroku/callback",
    "secret": "01234567-89ab-cdef-0123-456789abcdef",
    "updated_at": "2012-01-01T12:00:00Z"
  }
]

OAuth クライアントの更新

OAuth クライアントを更新します。

PATCH /oauth/clients/{oauth_client_id}

オプションパラメータ

名前	型	説明	例
name	文字列	OAuth クライアントの名前	`"example"`
redirect_uri	文字列	OAuth クライアントの認証後のリダイレクト用のエンドポイント	`"https://example.com/auth/heroku/callback"`

curl の例

$ curl -n -X PATCH https://api.heroku.com/oauth/clients/$OAUTH_CLIENT_ID \
  -d '{
  "name": "example",
  "redirect_uri": "https://example.com/auth/heroku/callback"
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "ignores_delinquent": false,
  "name": "example",
  "redirect_uri": "https://example.com/auth/heroku/callback",
  "secret": "01234567-89ab-cdef-0123-456789abcdef",
  "updated_at": "2012-01-01T12:00:00Z"
}

OAuth クライアントの資格情報のローテーション

OAuth クライアントの資格情報をローテーションします。

POST /oauth/clients/{oauth_client_id}/actions/rotate-credentials

curl の例

$ curl -n -X POST https://api.heroku.com/oauth/clients/$OAUTH_CLIENT_ID/actions/rotate-credentials \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "ignores_delinquent": false,
  "name": "example",
  "redirect_uri": "https://example.com/auth/heroku/callback",
  "secret": "01234567-89ab-cdef-0123-456789abcdef",
  "updated_at": "2012-01-01T12:00:00Z"
}

OAuth 許可

安定性: 本番環境

OAuth 許可は、ユーザーの代わりに認証を取得するために使用されます。詳細は、Heroku OAuth のドキュメントを参照してください。

OAuth トークン

安定性: 本番環境

OAuth トークンは、認証されているクライアントが、プラットフォームの使用を自動化、カスタマイズ、または拡張するために Heroku ユーザーの代わりに動作するためのアクセスを提供します。詳細は、Heroku OAuth のドキュメントを参照してください。

属性

名前	型	説明	例
access_token:expires_in	null 許容整数	OAuth トークンが期限切れになるまでの秒数。有効期間が無期限のトークンでは `null` になることがあります。	`2592000`
access_token:id	UUID	OAuth トークンの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
access_token:token	文字列	認証に使用されるトークンのコンテンツ	`"HRKU-01234567-89ab-cdef-0123-456789abcdef"`
authorization:id	UUID	OAuth 認証の一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
client	null 許容オブジェクト	トークンを取得するために使用される OAuth クライアントの秘密鍵	`null`
client:secret	文字列	このクライアントで OAuth 認証を取得するために使用される秘密鍵	`"01234567-89ab-cdef-0123-456789abcdef"`
created_at	日時	OAuth トークンが作成された日時	`"2012-01-01T12:00:00Z"`
grant:code	文字列	OAuth Web アプリケーション認証から受信された許可コード	`"01234567-89ab-cdef-0123-456789abcdef"`
grant:type	文字列	要求される許可のタイプ (`authorization_code` または `refresh_token` のいずれか)	`"authorization_code"`
id	UUID	OAuth トークンの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
refresh_token:expires_in	null 許容整数	OAuth トークンが期限切れになるまでの秒数。有効期間が無期限のトークンでは `null` になることがあります。	`2592000`
refresh_token:id	UUID	OAuth トークンの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
refresh_token:token	文字列	認証に使用されるトークンのコンテンツ	`"HRKU-01234567-89ab-cdef-0123-456789abcdef"`
session:id	UUID	OAuth トークンの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
updated_at	日時	OAuth トークンが更新された日時	`"2012-01-01T12:00:00Z"`
user:id	UUID	アカウントの識別子	`"01234567-89ab-cdef-0123-456789abcdef"`

OAuth トークンの作成

新しい OAuth トークンを作成します。

POST /oauth/tokens

必須パラメータ

名前	型	説明	例
client:secret	文字列	このクライアントで OAuth 認証を取得するために使用される秘密鍵	`"01234567-89ab-cdef-0123-456789abcdef"`
grant:code	文字列	OAuth Web アプリケーション認証から受信された許可コード	`"01234567-89ab-cdef-0123-456789abcdef"`
grant:type	文字列	要求される許可のタイプ (`authorization_code` または `refresh_token` のいずれか)	`"authorization_code"`
refresh_token:token	文字列	認証に使用されるトークンのコンテンツ	`"HRKU-01234567-89ab-cdef-0123-456789abcdef"`

curl の例

$ curl -n -X POST https://api.heroku.com/oauth/tokens \
  -d '{
  "client": {
    "secret": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "grant": {
    "code": "01234567-89ab-cdef-0123-456789abcdef",
    "type": "authorization_code"
  },
  "refresh_token": {
    "token": "HRKU-01234567-89ab-cdef-0123-456789abcdef"
  }
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 201 Created
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "access_token": {
    "expires_in": 2592000,
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "token": "HRKU-01234567-89ab-cdef-0123-456789abcdef"
  },
  "authorization": {
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "client": {
    "secret": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "created_at": "2012-01-01T12:00:00Z",
  "grant": {
    "code": "01234567-89ab-cdef-0123-456789abcdef",
    "type": "authorization_code"
  },
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "refresh_token": {
    "expires_in": 2592000,
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "token": "HRKU-01234567-89ab-cdef-0123-456789abcdef"
  },
  "session": {
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "updated_at": "2012-01-01T12:00:00Z",
  "user": {
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  }
}

OAuth トークンの削除

OAuth アクセストークンを取り消します。

DELETE /oauth/tokens/{oauth_token_id}

curl の例

$ curl -n -X DELETE https://api.heroku.com/oauth/tokens/$OAUTH_TOKEN_ID \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "access_token": {
    "expires_in": 2592000,
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "token": "HRKU-01234567-89ab-cdef-0123-456789abcdef"
  },
  "authorization": {
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "client": {
    "secret": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "created_at": "2012-01-01T12:00:00Z",
  "grant": {
    "code": "01234567-89ab-cdef-0123-456789abcdef",
    "type": "authorization_code"
  },
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "refresh_token": {
    "expires_in": 2592000,
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "token": "HRKU-01234567-89ab-cdef-0123-456789abcdef"
  },
  "session": {
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "updated_at": "2012-01-01T12:00:00Z",
  "user": {
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  }
}

OCI イメージ

安定性: プロトタイプ

OCI (Open Container Initiative) イメージとは、コンテナ化されたアプリケーションをパッケージ化して配布するための標準化された形式であり、プラットフォーム上ですぐに実行できます。

属性

名前	型	説明	例
architecture	null 許容文字列	OCI イメージのビルドアーキテクチャ	`"arm64"`
base_image_name	文字列	OCI イメージの基本レイヤーに使用されるイメージの名前	`"heroku/heroku:22-cnb"`
base_top_layer	文字列	ベースイメージの最上位レイヤーのダイジェスト。	`"sha256:ea36ae5fbc1e7230e0a782bf216fb46500e210382703baa6bab8acf2c6a23f78"`
buildpacks	配列	OCI イメージの Buildpack	`[{"id":"heroku/ruby","version":"2.0.0","homepage":"https://github.com/heroku/buildpacks-ruby"}]`
commit	文字列	バージョン管理システム内のコードの識別 (Git HEAD の SHA など)	`"60883d9e8947a57e04dc9124f25df004866a2051"`
commit_description	文字列	提供されたコミットのオプションの説明	`"fixed a bug with API documentation"`
created_at	日時	OCI イメージが作成された日時	`"2012-01-01T12:00:00Z"`
digest	文字列	OCI イメージのコンテンツを表す一意識別子	`"sha256:dc14ae5fbc1e7230e0a782bf216fb46500e210631703bcc6bab8acf2c6a23f42"`
id	UUID	OCI イメージの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
image_repo	文字列	保存に使用されるイメージレジストリリポジトリの名前	`"d7ba1ace-b396-4691-968c-37ae53153426/builds"`
process_types	オブジェクト	OCI イメージのプロセスタイプ	`{"web":{"name":"web","display_cmd":"bundle exec puma -p $PORT","command":"/cnb/process/web","working_dir":"/workspace/webapp","default":true}}`
stack:id	UUID	スタックの識別子	`"ba46bf09-7bd1-42fd-90df-a1a9a93eb4a2"`
stack:name	文字列	一意の名前	`"cnb"`
updated_at	日時	OCI イメージが更新された日時	`"2012-01-01T12:00:00Z"`

OCI イメージの情報

識別子によって絞り込まれた、アプリの OCI イメージに関する情報。

GET /apps/{app_id_or_name}/oci-images/{oci_image_id_or_digest}

curl の例

$ curl -n https://api.heroku.com/apps/$APP_ID_OR_NAME/oci-images/$OCI_IMAGE_ID_OR_DIGEST \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "base_image_name": "heroku/heroku:22-cnb",
    "base_top_layer": "sha256:ea36ae5fbc1e7230e0a782bf216fb46500e210382703baa6bab8acf2c6a23f78",
    "commit": "60883d9e8947a57e04dc9124f25df004866a2051",
    "commit_description": "fixed a bug with API documentation",
    "image_repo": "d7ba1ace-b396-4691-968c-37ae53153426/builds",
    "digest": "sha256:dc14ae5fbc1e7230e0a782bf216fb46500e210631703bcc6bab8acf2c6a23f42",
    "stack": {
      "id": "ba46bf09-7bd1-42fd-90df-a1a9a93eb4a2",
      "name": "cnb"
    },
    "process_types": {
      "web": {
        "name": "web",
        "display_cmd": "bundle exec puma -p $PORT",
        "command": "/cnb/process/web",
        "working_dir": "/workspace/webapp",
        "default": true
      }
    },
    "buildpacks": [
      {
        "id": "heroku/ruby",
        "version": "2.0.0",
        "homepage": "https://github.com/heroku/buildpacks-ruby"
      }
    ],
    "created_at": "2012-01-01T12:00:00Z",
    "updated_at": "2012-01-01T12:00:00Z",
    "architecture": "arm64"
  }
]

OCI イメージの作成

アプリの新しい OCI イメージを作成します

POST /apps/{app_id_or_name}/oci-images

オプションパラメータ

名前	型	説明	例
architecture	null 許容文字列	OCI イメージのビルドアーキテクチャ	`"arm64"`
base_image_name	文字列	OCI イメージの基本レイヤーに使用されるイメージの名前	`"heroku/heroku:22-cnb"`
base_top_layer	文字列	ベースイメージの最上位レイヤーのダイジェスト。	`"sha256:ea36ae5fbc1e7230e0a782bf216fb46500e210382703baa6bab8acf2c6a23f78"`
buildpacks	配列	OCI イメージの Buildpack	`[{"id":"heroku/ruby","version":"2.0.0","homepage":"https://github.com/heroku/buildpacks-ruby"}]`
commit	文字列	バージョン管理システム内のコードの識別 (Git HEAD の SHA など)	`"60883d9e8947a57e04dc9124f25df004866a2051"`
commit_description	文字列	提供されたコミットのオプションの説明	`"fixed a bug with API documentation"`
digest	文字列	OCI イメージのコンテンツを表す一意識別子	`"sha256:dc14ae5fbc1e7230e0a782bf216fb46500e210631703bcc6bab8acf2c6a23f42"`
image_repo	文字列	保存に使用されるイメージレジストリリポジトリの名前	`"d7ba1ace-b396-4691-968c-37ae53153426/builds"`
process_types	オブジェクト	OCI イメージのプロセスタイプ	`{"web":{"name":"web","display_cmd":"bundle exec puma -p $PORT","command":"/cnb/process/web","working_dir":"/workspace/webapp","default":true}}`
stack	文字列	スタックの一意の名前または識別子	`"cnb"` または `"01234567-89ab-cdef-0123-456789abcdef"`

curl の例

$ curl -n -X POST https://api.heroku.com/apps/$APP_ID_OR_NAME/oci-images \
  -d '{
  "architecture": "arm64",
  "base_image_name": "heroku/heroku:22-cnb",
  "base_top_layer": "sha256:ea36ae5fbc1e7230e0a782bf216fb46500e210382703baa6bab8acf2c6a23f78",
  "commit": "60883d9e8947a57e04dc9124f25df004866a2051",
  "commit_description": "fixed a bug with API documentation",
  "image_repo": "d7ba1ace-b396-4691-968c-37ae53153426/builds",
  "digest": "sha256:dc14ae5fbc1e7230e0a782bf216fb46500e210631703bcc6bab8acf2c6a23f42",
  "stack": "01234567-89ab-cdef-0123-456789abcdef",
  "process_types": {
    "web": {
      "name": "web",
      "display_cmd": "bundle exec puma -p $PORT",
      "command": "/cnb/process/web",
      "working_dir": "/workspace/webapp",
      "default": true
    }
  },
  "buildpacks": [
    {
      "id": "heroku/ruby",
      "version": "2.0.0",
      "homepage": "https://github.com/heroku/buildpacks-ruby"
    }
  ]
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 201 Created
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "base_image_name": "heroku/heroku:22-cnb",
  "base_top_layer": "sha256:ea36ae5fbc1e7230e0a782bf216fb46500e210382703baa6bab8acf2c6a23f78",
  "commit": "60883d9e8947a57e04dc9124f25df004866a2051",
  "commit_description": "fixed a bug with API documentation",
  "image_repo": "d7ba1ace-b396-4691-968c-37ae53153426/builds",
  "digest": "sha256:dc14ae5fbc1e7230e0a782bf216fb46500e210631703bcc6bab8acf2c6a23f42",
  "stack": {
    "id": "ba46bf09-7bd1-42fd-90df-a1a9a93eb4a2",
    "name": "cnb"
  },
  "process_types": {
    "web": {
      "name": "web",
      "display_cmd": "bundle exec puma -p $PORT",
      "command": "/cnb/process/web",
      "working_dir": "/workspace/webapp",
      "default": true
    }
  },
  "buildpacks": [
    {
      "id": "heroku/ruby",
      "version": "2.0.0",
      "homepage": "https://github.com/heroku/buildpacks-ruby"
    }
  ],
  "created_at": "2012-01-01T12:00:00Z",
  "updated_at": "2012-01-01T12:00:00Z",
  "architecture": "arm64"
}

PasswordReset

安定性: 本番環境

パスワードのリセットは、インプロセスでのパスワードのリセット試行を表します。

属性

名前	型	説明	例
created_at	日時	パスワードのリセットが作成された日時	`"2012-01-01T12:00:00Z"`
user:email	メール	一意のメールアドレス	`"username@example.com"`
user:id	UUID	アカウントの識別子	`"01234567-89ab-cdef-0123-456789abcdef"`

PasswordReset パスワードのリセット

アカウントのパスワードをリセットします。これにより、パスワードのリセットのリンクがユーザーのメールアドレスに送信されます。

POST /password-resets

必須パラメータ

名前	型	説明	例
email	メール	一意のメールアドレス	`"username@example.com"`

curl の例

$ curl -n -X POST https://api.heroku.com/password-resets \
  -d '{
  "email": "username@example.com"
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "created_at": "2012-01-01T12:00:00Z",
  "user": {
    "email": "username@example.com",
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  }
}

PasswordReset パスワードのリセットの完了

パスワードのリセットを完了します。

POST /password-resets/{password_reset_reset_password_token}/actions/finalize

必須パラメータ

名前	型	説明	例
password	文字列	アカウントの現在のパスワード	`"currentpassword"`
password_confirmation	文字列	新しいパスワードの確認	`"newpassword"`

curl の例

$ curl -n -X POST https://api.heroku.com/password-resets/$PASSWORD_RESET_RESET_PASSWORD_TOKEN/actions/finalize \
  -d '{
  "password": "currentpassword",
  "password_confirmation": "newpassword"
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "created_at": "2012-01-01T12:00:00Z",
  "user": {
    "email": "username@example.com",
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  }
}

ピアリング

安定性: プロトタイプ

ピアリングは、Private Space VPC を別の AWS VPC にピアリングするための方法を提供します。

属性

名前	型	説明	例
aws_account_id	文字列	Private Space の AWS アカウント ID	`"123456789012"`
aws_region	文字列	ピア接続の AWS リージョン	`"us-east-1"`
aws_vpc_id	文字列	ピアの AWS VPC ID	`"vpc-1234567890"`
cidr_blocks	配列	ピアの CIDR ブロック	`["10.0.0.0/16"]`
expires	日時	ピアリング接続が期限切れになる日時	`"2020-01-01T12:00:00Z"`
pcx_id	文字列	ピアリングの AWS VPC ピアリング接続 ID	`"pcx-123456789012"`
status	文字列	ピアリング接続のステータス。次のうちのいずれか: `"initiating-request"`、`"pending-acceptance"`、`"provisioning"`、`"active"`、`"failed"`、`"expired"`、`"rejected"`、`"deleted"`	`"pending-acceptance"`
type	文字列	ピアリング接続のタイプ。次のうちのいずれか: `"heroku-managed"`、`"customer-managed"`、`"unknown"`	`"heroku-managed"`

ピアリングの一覧

Private Space のピアリング接続を一覧表示します。

GET /spaces/{space_id_or_name}/peerings

curl の例

$ curl -n https://api.heroku.com/spaces/$SPACE_ID_OR_NAME/peerings \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "type": "heroku-managed",
    "pcx_id": "pcx-123456789012",
    "cidr_blocks": [
      "10.0.0.0/16"
    ],
    "status": "pending-acceptance",
    "aws_vpc_id": "vpc-1234567890",
    "aws_region": "us-east-1",
    "aws_account_id": "123456789012",
    "expires": "2020-01-01T12:00:00Z"
  }
]

ピアリングの受け入れ

Private Space との保留中のピアリング接続を受け入れます。

POST /spaces/{space_id_or_name}/peerings/{peering_pcx_id}/actions/accept

curl の例

$ curl -n -X POST https://api.heroku.com/spaces/$SPACE_ID_OR_NAME/peerings/$PEERING_PCX_ID/actions/accept \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 202 Accepted
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

ピアリングの破棄

Private Space とのアクティブなピアリング接続を破棄します。

DELETE /spaces/{space_id_or_name}/peerings/{peering_pcx_id}

curl の例

$ curl -n -X DELETE https://api.heroku.com/spaces/$SPACE_ID_OR_NAME/peerings/$PEERING_PCX_ID \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 202 Accepted
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

ピアリングの情報

既存のピアリング接続に関する情報をフェッチします。

GET /spaces/{space_id_or_name}/peerings/{peering_pcx_id}

curl の例

$ curl -n https://api.heroku.com/spaces/$SPACE_ID_OR_NAME/peerings/$PEERING_PCX_ID \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "type": "heroku-managed",
  "pcx_id": "pcx-123456789012",
  "cidr_blocks": [
    "10.0.0.0/16"
  ],
  "status": "pending-acceptance",
  "aws_vpc_id": "vpc-1234567890",
  "aws_region": "us-east-1",
  "aws_account_id": "123456789012",
  "expires": "2020-01-01T12:00:00Z"
}

ピアリング情報

安定性: プロトタイプ

ピアリング情報は、AWS VPC を Private Space にピアリングするために必要な情報を提供します。

属性

名前	型	説明	例
aws_account_id	文字列	Private Space の AWS アカウント ID	`"123456789012"`
aws_region	文字列	プロバイダーによって使用されるリージョン名次のうちのいずれか: `"ap-south-1"`、`"eu-west-1"`、`"ap-southeast-1"`、`"ap-southeast-2"`、`"eu-central-1"`、`"eu-west-2"`、`"ap-northeast-2"`、`"ap-northeast-1"`、`"us-east-1"`、`"sa-east-1"`、`"us-west-1"`、`"us-west-2"`、`"ca-central-1"`	`"us-east-1"`
dyno_cidr_blocks	配列	Private Space VPC にルーティングする CIDR 範囲。	`["10.0.0.0/16"]`
space_cidr_blocks	配列	Private Space VPC にルーティングする CIDR 範囲。	`["10.0.0.0/16"]`
unavailable_cidr_blocks	配列	競合してはいけない CIDR 範囲	`["10.0.0.0/16"]`
vpc_cidr	文字列	Private Space VPC の CIDR 範囲	`"10.0.0.0/16"`
vpc_id	文字列	ピアの AWS VPC ID	`"vpc-1234567890"`

ピアリング情報の情報

Private Space との AWS VPC ピアリングを確立するために必要な情報を提供します。

GET /spaces/{space_id_or_name}/peering-info

curl の例

$ curl -n https://api.heroku.com/spaces/$SPACE_ID_OR_NAME/peering-info \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "aws_account_id": "123456789012",
  "aws_region": "us-east-1",
  "vpc_id": "vpc-1234567890",
  "vpc_cidr": "10.0.0.0/16",
  "dyno_cidr_blocks": [
    "10.0.0.0/16"
  ],
  "unavailable_cidr_blocks": [
    "10.0.0.0/16"
  ],
  "space_cidr_blocks": [
    "10.0.0.0/16"
  ]
}

アクセス許可エンティティ

安定性: 開発

ユーザーのアクセス許可を含む所有されているエンティティ。

属性

名前	型	説明	例
id	UUID	エンティティの ID	`"01234567-89ab-cdef-0123-456789abcdef"`
name	文字列	エンティティの名前	`"polar-lake-12345"`
team_id	UUID	チームの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
type	文字列	このエンティティが参照しているオブジェクトのタイプ。次のうちのいずれか: `"app"`、`"space"`	`"app"`
users/email	メール	一意のメールアドレス	`"username@example.com"`
users/id	UUID	アカウントの識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
users/permissions	配列	エンタープライズアカウントのアクセス許可	`[null]`

アクセス許可エンティティの一覧

チームのアクセス許可エンティティを一覧表示します。

GET /teams/{team_name_or_id}/permissions

curl の例

$ curl -n https://api.heroku.com/teams/$TEAM_NAME_OR_ID/permissions \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "polar-lake-12345",
    "team_id": "01234567-89ab-cdef-0123-456789abcdef",
    "type": "app",
    "users": [
      {
        "email": "username@example.com",
        "id": "01234567-89ab-cdef-0123-456789abcdef",
        "permissions": [
          null
        ]
      }
    ]
  }
]

パイプライン

安定性: 本番環境

パイプラインを使用すると、アプリをさまざまなステージにグループ化できます。

属性

名前	型	説明	例
created_at	日時	パイプラインが作成された日時	`"2012-01-01T12:00:00Z"`
generation:id	UUID	このパイプラインの Heroku プラットフォームの世代の一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
generation:name	文字列	このパイプラインの Heroku プラットフォームの世代の一意の名前	`"cedar"`
id	UUID	パイプラインの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
name	文字列	パイプラインの名前パターン: `^[a-z][a-z0-9-]{2,29}$`	`"example"`
owner	null 許容オブジェクト	パイプラインの所有者	`null`
owner:id	UUID	パイプライン所有者の一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
owner:type	文字列	パイプライン所有者のタイプパターン: `(^team$\|^user$)`	`"team"`
updated_at	日時	パイプラインが更新された日時	`"2012-01-01T12:00:00Z"`

パイプラインの作成

新しいパイプラインを作成します。

POST /pipelines

必須パラメータ

名前	型	説明	例
name	文字列	パイプラインの名前パターン: `^[a-z][a-z0-9-]{2,29}$`	`"example"`

curl の例

$ curl -n -X POST https://api.heroku.com/pipelines \
  -d '{
  "name": "example",
  "owner": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "type": "team"
  }
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 201 Created
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "name": "example",
  "owner": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "type": "team"
  },
  "updated_at": "2012-01-01T12:00:00Z",
  "generation": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "cedar"
  }
}

パイプラインの情報

既存のパイプラインに関する情報。

GET /pipelines/{pipeline_id_or_name}

curl の例

$ curl -n https://api.heroku.com/pipelines/$PIPELINE_ID_OR_NAME \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "name": "example",
  "owner": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "type": "team"
  },
  "updated_at": "2012-01-01T12:00:00Z",
  "generation": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "cedar"
  }
}

パイプラインの削除

既存のパイプラインを削除します。

DELETE /pipelines/{pipeline_id}

curl の例

$ curl -n -X DELETE https://api.heroku.com/pipelines/$PIPELINE_ID \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "name": "example",
  "owner": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "type": "team"
  },
  "updated_at": "2012-01-01T12:00:00Z",
  "generation": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "cedar"
  }
}

パイプラインの更新

既存のパイプラインを更新します。

PATCH /pipelines/{pipeline_id}

オプションパラメータ

名前	型	説明	例
name	文字列	パイプラインの名前パターン: `^[a-z][a-z0-9-]{2,29}$`	`"example"`

curl の例

$ curl -n -X PATCH https://api.heroku.com/pipelines/$PIPELINE_ID \
  -d '{
  "name": "example"
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "name": "example",
  "owner": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "type": "team"
  },
  "updated_at": "2012-01-01T12:00:00Z",
  "generation": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "cedar"
  }
}

パイプラインの一覧

既存のパイプラインを一覧表示します。

Range ヘッダーの容認可能な順序の値は id または name です。

GET /pipelines

curl の例

$ curl -n https://api.heroku.com/pipelines \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: id, name
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "created_at": "2012-01-01T12:00:00Z",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example",
    "owner": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "type": "team"
    },
    "updated_at": "2012-01-01T12:00:00Z",
    "generation": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "cedar"
    }
  }
]

パイプラインビルド

安定性: 本番環境

パイプライン内のアプリの最新ビルドに関する情報。ビルドは、コードをビルドアーティファクトに変換するプロセスを表します。

属性

名前	型	説明	例
app:id	UUID	アプリの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
buildpacks	null 許容配列	このビルドのために順番に実行された buildpack (Cedar 世代のアプリにのみ適用)	`null`
buildpacks/name	文字列	アプリの buildpack の Buildpack Registry 名	`"heroku/ruby"`
buildpacks/url	文字列	アプリの buildpack の URL	`"https://github.com/heroku/heroku-buildpack-ruby"`
created_at	日時	ビルドが作成された日時	`"2012-01-01T12:00:00Z"`
id	UUID	ビルドの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
output_stream_url	文字列	ビルドプロセスの出力のストリーミング URL	`"https://build-output.heroku.com/streams/01234567-89ab-cdef-0123-456789abcdef"`
release	null 許容オブジェクト	ビルドの結果として得られるリリース	`{"id":"01234567-89ab-cdef-0123-456789abcdef"}`
release:id	UUID	リリースの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
slug	null 許容オブジェクト	このビルドによって作成される slug	`null`
slug:id	UUID	slug の一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
source_blob:checksum	null 許容文字列	その完全性を確認するための gzip で圧縮された tarball のオプションのチェックサム	`"SHA256:e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"`
source_blob:url	文字列	ビルドのためのソースコードの gzip で圧縮された tar アーカイブがダウンロードされた URL	`"https://example.com/source.tgz?token=xyz"`
source_blob:version	null 許容文字列	gzip で圧縮された tarball のバージョン	`"v1.3.0"`
source_blob:version_description	null 許容文字列	gzip で圧縮された tarball のバージョンの説明	`"* Fake User: Change session key"`
stack	文字列	ビルドのスタック	`"heroku-24"`
status	文字列	ビルドのステータス次のうちのいずれか: `"failed"`、`"pending"`、`"succeeded"`	`"succeeded"`
updated_at	日時	ビルドが更新された日時	`"2012-01-01T12:00:00Z"`
user:email	メール	一意のメールアドレス	`"username@example.com"`
user:id	UUID	アカウントの識別子	`"01234567-89ab-cdef-0123-456789abcdef"`

パイプラインビルドの一覧

パイプライン内の各アプリの最新のビルドを一覧表示します。

GET /pipelines/{pipeline_id}/latest-builds

curl の例

$ curl -n https://api.heroku.com/pipelines/$PIPELINE_ID/latest-builds \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "app": {
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    },
    "buildpacks": [
      {
        "url": "https://github.com/heroku/heroku-buildpack-ruby",
        "name": "heroku/ruby"
      }
    ],
    "created_at": "2012-01-01T12:00:00Z",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "output_stream_url": "https://build-output.heroku.com/streams/01234567-89ab-cdef-0123-456789abcdef",
    "source_blob": {
      "checksum": "SHA256:e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
      "url": "https://example.com/source.tgz?token=xyz",
      "version": "v1.3.0",
      "version_description": "* Fake User: Change session key"
    },
    "release": {
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    },
    "slug": {
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    },
    "stack": "heroku-24",
    "status": "succeeded",
    "updated_at": "2012-01-01T12:00:00Z",
    "user": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "email": "username@example.com"
    }
  }
]

パイプラインの環境設定

安定性: 本番環境

Heroku CI やレビューアプリでは、パイプラインの環境設定を使用してパイプラインの設定情報を管理します。

属性

名前	型	説明	例
[“NAME”]: [“value”]	オブジェクト	ユーザー定義の環境設定の名前と値	`{"FOO":"bar"}`

アプリのパイプラインの環境設定の情報

パイプラインステージの環境設定を取得します。

GET /pipelines/{pipeline_id}/stage/{pipeline_coupling_stage}/config-vars

curl の例

$ curl -n https://api.heroku.com/pipelines/$PIPELINE_ID/stage/$PIPELINE_COUPLING_STAGE/config-vars \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "FOO": "bar",
  "BAZ": "qux"
}

パイプラインの環境設定の更新

パイプラインステージの環境設定を更新します。再び設定することによって既存の環境設定を更新したり、null に設定することによって削除したりできます。

PATCH /pipelines/{pipeline_id}/stage/{pipeline_coupling_stage}/config-vars

curl の例

$ curl -n -X PATCH https://api.heroku.com/pipelines/$PIPELINE_ID/stage/$PIPELINE_COUPLING_STAGE/config-vars \
  -d '{
  "FOO": "bar",
  "BAZ": "qux"
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "FOO": "bar",
  "BAZ": "qux"
}

パイプラインカップリング

安定性: 本番環境

パイプラインへのアプリのカップリングに関する情報。

属性

名前	型	説明	例
app:id	UUID	一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
created_at	日時	パイプラインカップリングが作成された日時	`"2012-01-01T12:00:00Z"`
id	UUID	パイプラインカップリングの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
pipeline:id	UUID	パイプラインの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
stage	文字列	ターゲットのパイプラインステージ次のうちのいずれか: `"test"`、`"review"`、`"development"`、`"staging"`、`"production"`	`"production"`
updated_at	日時	パイプラインカップリングが更新された日時	`"2012-01-01T12:00:00Z"`

パイプラインごとのパイプラインカップリングの一覧

パイプラインのカップリングを一覧表示します。

Range ヘッダーの唯一の容認可能な順序の値は id です。

GET /pipelines/{pipeline_id}/pipeline-couplings

curl の例

$ curl -n https://api.heroku.com/pipelines/$PIPELINE_ID/pipeline-couplings \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: id
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "app": {
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    },
    "created_at": "2012-01-01T12:00:00Z",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "pipeline": {
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    },
    "stage": "production",
    "updated_at": "2012-01-01T12:00:00Z"
  }
]

現在のユーザーごとのパイプラインカップリングの一覧

現在のユーザーのパイプラインカップリングを一覧表示します。

Range ヘッダーの唯一の容認可能な順序の値は id です。

GET /users/~/pipeline-couplings

curl の例

$ curl -n https://api.heroku.com/users/~/pipeline-couplings \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: id
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "app": {
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    },
    "created_at": "2012-01-01T12:00:00Z",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "pipeline": {
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    },
    "stage": "production",
    "updated_at": "2012-01-01T12:00:00Z"
  }
]

パイプラインカップリングの一覧

パイプラインカップリングを一覧表示します。

Range ヘッダーの唯一の容認可能な順序の値は id です。

GET /pipeline-couplings

curl の例

$ curl -n https://api.heroku.com/pipeline-couplings \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: id
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "app": {
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    },
    "created_at": "2012-01-01T12:00:00Z",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "pipeline": {
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    },
    "stage": "production",
    "updated_at": "2012-01-01T12:00:00Z"
  }
]

チームごとのパイプラインカップリングの一覧

チームのパイプラインカップリングを一覧表示します。

Range ヘッダーの唯一の容認可能な順序の値は id です。

GET /teams/{team_name_or_id}/pipeline-couplings

curl の例

$ curl -n https://api.heroku.com/teams/$TEAM_NAME_OR_ID/pipeline-couplings \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: id
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "app": {
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    },
    "created_at": "2012-01-01T12:00:00Z",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "pipeline": {
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    },
    "stage": "production",
    "updated_at": "2012-01-01T12:00:00Z"
  }
]

パイプラインカップリングの作成

新しいパイプラインカップリングを作成します。

POST /pipeline-couplings

必須パラメータ

名前	型	説明	例
app	文字列	アプリの一意識別子または名前	`"01234567-89ab-cdef-0123-456789abcdef"` または `"example"`
pipeline	UUID	パイプラインの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
stage	文字列	ターゲットのパイプラインステージ次のうちのいずれか: `"test"`、`"review"`、`"development"`、`"staging"`、`"production"`	`"production"`

curl の例

$ curl -n -X POST https://api.heroku.com/pipeline-couplings \
  -d '{
  "app": "01234567-89ab-cdef-0123-456789abcdef",
  "pipeline": "01234567-89ab-cdef-0123-456789abcdef",
  "stage": "production"
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 201 Created
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "app": {
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "pipeline": {
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "stage": "production",
  "updated_at": "2012-01-01T12:00:00Z"
}

パイプラインカップリングの情報

既存のパイプラインカップリングに関する情報。

GET /pipeline-couplings/{pipeline_coupling_id}

curl の例

$ curl -n https://api.heroku.com/pipeline-couplings/$PIPELINE_COUPLING_ID \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "app": {
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "pipeline": {
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "stage": "production",
  "updated_at": "2012-01-01T12:00:00Z"
}

パイプラインカップリングの削除

既存のパイプラインカップリングを削除します。

DELETE /pipeline-couplings/{pipeline_coupling_id}

curl の例

$ curl -n -X DELETE https://api.heroku.com/pipeline-couplings/$PIPELINE_COUPLING_ID \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "app": {
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "pipeline": {
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "stage": "production",
  "updated_at": "2012-01-01T12:00:00Z"
}

パイプラインカップリングの更新

既存のパイプラインカップリングを更新します。

PATCH /pipeline-couplings/{pipeline_coupling_id}

オプションパラメータ

名前	型	説明	例
stage	文字列	ターゲットのパイプラインステージ次のうちのいずれか: `"test"`、`"review"`、`"development"`、`"staging"`、`"production"`	`"production"`

curl の例

$ curl -n -X PATCH https://api.heroku.com/pipeline-couplings/$PIPELINE_COUPLING_ID \
  -d '{
  "stage": "production"
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "app": {
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "pipeline": {
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "stage": "production",
  "updated_at": "2012-01-01T12:00:00Z"
}

アプリごとのパイプラインカップリングの情報

既存のパイプラインカップリングに関する情報。

GET /apps/{app_id_or_name}/pipeline-couplings

curl の例

$ curl -n https://api.heroku.com/apps/$APP_ID_OR_NAME/pipeline-couplings \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "app": {
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "pipeline": {
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "stage": "production",
  "updated_at": "2012-01-01T12:00:00Z"
}

パイプラインデプロイ

安定性: 本番環境

パイプライン内の各アプリの最新デプロイに関する情報。デプロイとは、ビルドアーティファクトをターゲット環境に移動するプロセスのことです。

属性

名前	型	説明	例
addon_plan_names	配列	このデプロイのアプリにインストールされているアドオンプラン	`["heroku-postgresql:dev"]`
app:id	UUID	アプリの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
app:name	文字列	アプリの一意の名前パターン: `^[a-z][a-z0-9-]{1,28}[a-z0-9]$`	`"example"`
artifacts:id	文字列	一意識別子または OCI イメージの識別子	`"01234567-89ab-cdef-0123-456789abcdef"` または `"01234567-89ab-cdef-0123-456789abcdef"`
artifacts:type	文字列	アーティファクトのタイプ	`"slug"`
created_at	日時	デプロイが作成された日時	`"2012-01-01T12:00:00Z"`
current	ブール値	このデプロイがアプリの現在のデプロイであるかどうかを示します	`true`
description	文字列	このデプロイでの変更の説明	`"Added new feature"`
eligible_for_rollback	ブール値	このデプロイがロールバックの対象となるかどうかを示します	`true`
id	UUID	デプロイの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
output_stream_url	null 許容文字列	release コマンドの出力のストリーミング URL	`"https://release-output.heroku.com/streams/01234567-89ab-cdef-0123-456789abcdef"`
slug	null 許容オブジェクト	このデプロイで実行されている slug	`null`
slug:id	UUID	slug の一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
status	文字列	デプロイの現在のステータス次のうちのいずれか: `"failed"`、`"pending"`、`"succeeded"`	`"succeeded"`
updated_at	日時	デプロイが更新された日時	`"2012-01-01T12:00:00Z"`
user:email	メール	一意のメールアドレス	`"username@example.com"`
user:id	UUID	アカウントの識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
version	整数	デプロイに割り当てられている固有のバージョン	`11`

パイプラインデプロイの一覧

パイプライン内の各アプリの最新のデプロイを一覧表示します。デプロイとは、ソース slug、コンテナイメージ、または Heroku プロセスを変更したリリースのことです。

Range ヘッダーの容認可能な順序の値は id または version です。

GET /pipelines/{pipeline_id}/latest-deployments

curl の例

$ curl -n https://api.heroku.com/pipelines/$PIPELINE_ID/latest-deployments \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: id, version
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "addon_plan_names": [
      "heroku-postgresql:dev"
    ],
    "artifacts": [
      {
        "type": "slug",
        "id": "01234567-89ab-cdef-0123-456789abcdef"
      }
    ],
    "app": {
      "name": "example",
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    },
    "created_at": "2012-01-01T12:00:00Z",
    "description": "Added new feature",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "updated_at": "2012-01-01T12:00:00Z",
    "slug": {
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    },
    "status": "succeeded",
    "user": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "email": "username@example.com"
    },
    "version": 11,
    "current": true,
    "output_stream_url": "https://release-output.heroku.com/streams/01234567-89ab-cdef-0123-456789abcdef",
    "eligible_for_rollback": true
  }
]

パイプラインプロモーション

安定性: 本番環境

プロモーションを使用すると、パイプライン内のアプリからすべてのターゲットにコードを移動できます。

属性

名前	型	説明	例
created_at	日時	プロモーションが作成された日時	`"2012-01-01T12:00:00Z"`
id	UUID	プロモーションの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
pipeline:id	UUID	パイプラインの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
source:app:id	UUID	一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
source:release:id	UUID	リリースの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
status	文字列	プロモーションのステータス次のうちのいずれか: `"pending"`、`"completed"`	`"pending"`
updated_at	null 許容日時	プロモーションが更新された日時	`"2012-01-01T12:00:00Z"`

パイプラインプロモーションの作成

新しいプロモーションを作成します。

POST /pipeline-promotions

必須パラメータ

名前	型	説明	例
pipeline:id	UUID	パイプラインの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
source:app:id	UUID	一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
targets/app:id	UUID	一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`

curl の例

$ curl -n -X POST https://api.heroku.com/pipeline-promotions \
  -d '{
  "pipeline": {
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "source": {
    "app": {
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    }
  },
  "targets": [
    {
      "app": {
        "id": "01234567-89ab-cdef-0123-456789abcdef"
      }
    }
  ]
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 201 Created
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "pipeline": {
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "source": {
    "app": {
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    },
    "release": {
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    }
  },
  "status": "pending",
  "updated_at": "2012-01-01T12:00:00Z"
}

パイプラインプロモーションの情報

既存のパイプラインプロモーションに関する情報。

GET /pipeline-promotions/{pipeline_promotion_id}

curl の例

$ curl -n https://api.heroku.com/pipeline-promotions/$PIPELINE_PROMOTION_ID \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "pipeline": {
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "source": {
    "app": {
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    },
    "release": {
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    }
  },
  "status": "pending",
  "updated_at": "2012-01-01T12:00:00Z"
}

パイプラインプロモーションターゲット

安定性: 本番環境

プロモーションターゲットは、プロモート先の個々のアプリを表します。

属性

名前	型	説明	例
app:id	UUID	一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
error_message	null 許容文字列	プロモーションが失敗した理由を示すエラーメッセージ	`"User does not have access to that app"`
id	UUID	プロモーションターゲットの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
pipeline_promotion:id	UUID	プロモーションの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
release	null 許容オブジェクト	ターゲットアプリで作成されたリリース	`null`
release:id	UUID	リリースの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
status	文字列	プロモーションのステータス次のうちのいずれか: `"pending"`、`"succeeded"`、`"failed"`	`"pending"`

パイプラインプロモーションターゲットの一覧

既存のプロモーションに属するプロモーションターゲットを一覧表示します。

Range ヘッダーの唯一の容認可能な順序の値は id です。

GET /pipeline-promotions/{pipeline_promotion_id}/promotion-targets

curl の例

$ curl -n https://api.heroku.com/pipeline-promotions/$PIPELINE_PROMOTION_ID/promotion-targets \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: id
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "app": {
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    },
    "error_message": "User does not have access to that app",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "pipeline_promotion": {
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    },
    "release": {
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    },
    "status": "pending"
  }
]

パイプラインリリース

安定性: 本番環境

パイプライン内の各アプリの最新リリースに関する情報。リリースされるとエンドユーザーがデプロイを利用できるようになります。

属性

名前	型	説明	例
addon_plan_names	配列	このリリースのアプリにインストールされているアドオンプラン	`["heroku-postgresql:dev"]`
app:id	UUID	アプリの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
app:name	文字列	アプリの一意の名前パターン: `^[a-z][a-z0-9-]{1,28}[a-z0-9]$`	`"example"`
artifacts:id	文字列	一意識別子または OCI イメージの識別子	`"01234567-89ab-cdef-0123-456789abcdef"` または `"01234567-89ab-cdef-0123-456789abcdef"`
artifacts:type	文字列	アーティファクトのタイプ	`"slug"`
created_at	日時	リリースが作成された日時	`"2012-01-01T12:00:00Z"`
current	ブール値	このリリースがアプリの現在のリリースであるかどうかを示します	`true`
description	文字列	このリリースでの変更の説明	`"Added new feature"`
eligible_for_rollback	ブール値	このリリースがロールバックの対象となるかどうかを示します	`true`
id	UUID	リリースの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
output_stream_url	null 許容文字列	ビルドプロセスの出力のストリーミング URL	`"https://release-output.heroku.com/streams/01234567-89ab-cdef-0123-456789abcdef"`
slug	null 許容オブジェクト	リリースで実行されている slug	`null`
slug:id	UUID	slug の一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
status	文字列	リリースの現在のステータス次のうちのいずれか: `"failed"`、`"pending"`、`"succeeded"`	`"succeeded"`
updated_at	日時	リリースが更新された日時	`"2012-01-01T12:00:00Z"`
user:email	メール	一意のメールアドレス	`"username@example.com"`
user:id	UUID	アカウントの識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
version	整数	リリースに割り当てられている固有のバージョン	`11`

パイプラインリリースの一覧

パイプライン内の各アプリの最新のリリースを一覧表示します。

GET /pipelines/{pipeline_id}/latest-releases

curl の例

$ curl -n https://api.heroku.com/pipelines/$PIPELINE_ID/latest-releases \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "addon_plan_names": [
      "heroku-postgresql:dev"
    ],
    "artifacts": [
      {
        "type": "slug",
        "id": "01234567-89ab-cdef-0123-456789abcdef"
      }
    ],
    "app": {
      "name": "example",
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    },
    "created_at": "2012-01-01T12:00:00Z",
    "description": "Added new feature",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "updated_at": "2012-01-01T12:00:00Z",
    "slug": {
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    },
    "status": "succeeded",
    "user": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "email": "username@example.com"
    },
    "version": 11,
    "current": true,
    "output_stream_url": "https://release-output.heroku.com/streams/01234567-89ab-cdef-0123-456789abcdef",
    "eligible_for_rollback": true
  }
]

パイプラインスタック

安定性: 本番環境

パイプラインのスタックは、そのパイプライン内のアプリによって決定されます。これは、app.json でスタックが定義されていない CI とレビューアプリの作成中に使用されます。

属性

名前	型	説明	例
stack	null 許容オブジェクト	CI とレビューアプリでスタックが定義されていない新しいビルドに使用されるスタックの ID	`null`
stack:id	UUID	スタックの識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
stack:name	文字列	一意の名前	`"heroku-18"`

パイプラインスタックのデフォルトスタック

app.json でスタックが定義されていない CI とレビューアプリに使用される、特定のパイプラインのスタック。

GET /pipelines/{pipeline_id}/pipeline-stack

curl の例

$ curl -n https://api.heroku.com/pipelines/$PIPELINE_ID/pipeline-stack \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "stack": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "heroku-18"
  }
}

パイプラインの移動

安定性: 本番環境

パイプラインの移動は、含まれているアプリと共にパイプラインの所有権を変更するプロセスです。

属性

名前	型	説明	例
new_owner:id	UUID	パイプライン所有者の一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
new_owner:type	文字列	パイプライン所有者のタイプパターン: `(^team$\|^user$)`	`"team"`
pipeline:id	UUID	パイプラインの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
previous_owner:id	UUID	パイプライン所有者の一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
previous_owner:type	文字列	パイプライン所有者のタイプパターン: `(^team$\|^user$)`	`"team"`

パイプラインの移動の作成

新しいパイプラインの移動を作成します。

POST /pipeline-transfers

必須パラメータ

名前	型	説明	例
new_owner:id	UUID	パイプライン所有者の一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
new_owner:type	文字列	パイプライン所有者のタイプパターン: `(^team$\|^user$)`	`"team"`
pipeline:id	UUID	パイプラインの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`

curl の例

$ curl -n -X POST https://api.heroku.com/pipeline-transfers \
  -d '{
  "pipeline": {
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "new_owner": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "type": "team"
  }
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 201 Created
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "pipeline": {
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "previous_owner": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "type": "team"
  },
  "new_owner": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "type": "team"
  }
}

プラン

安定性: 本番環境

プランは、アプリに追加できるアドオンのさまざまな設定を表します。アドオンサービスの下のエンドポイントには認証なしでアクセスできます。

属性

名前	型	説明	例
addon_service:id	UUID	このアドオンサービスの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
addon_service:name	文字列	このアドオンサービスの一意の名前	`"heroku-postgresql"`
compliance	null 許容配列	アドオンプランに適用されるコンプライアンス制度	`["HIPAA"]`
created_at	日時	プランが作成された日時	`"2012-01-01T12:00:00Z"`
default	ブール値	このプランがそのアドオンサービスのデフォルトであるかどうか	`false`
description	文字列	プランの説明	`"Heroku Postgres Dev"`
human_name	文字列	アドオンプランの人間に解読可能な名前	`"Dev"`
id	UUID	一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
installable_inside_private_network	ブール値	このプランが Private Spaces アプリにインストールできるかどうか	`false`
installable_outside_private_network	ブール値	このプランが Common Runtime アプリにインストールできるかどうか	`true`
name	文字列	このプランの名前	`"heroku-postgresql:dev"`
price:cents	整数	プランの単位あたりの価格 (セント)	`0`
price:contract	ブール値	価格が毎月のアドオン請求以外の契約でネゴシエートされるかどうか	`false`
price:unit	文字列	プランの価格の単位	`"month"`
space_default	ブール値	このプランが Private Spaces 内のアプリのデフォルトであるかどうか	`false`
state	文字列	プランのリリースステータス	`"public"`
updated_at	日時	プランが更新された日時	`"2012-01-01T12:00:00Z"`
visible	ブール値	このプランが一般に表示されるかどうか	`true`

プランの情報

既存のプランに関する情報。

GET /plans/{plan_id_or_name}

curl の例

$ curl -n https://api.heroku.com/plans/$PLAN_ID_OR_NAME \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "addon_service": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "heroku-postgresql"
  },
  "created_at": "2012-01-01T12:00:00Z",
  "compliance": [
    "HIPAA"
  ],
  "default": false,
  "description": "Heroku Postgres Dev",
  "human_name": "Dev",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "installable_inside_private_network": false,
  "installable_outside_private_network": true,
  "name": "heroku-postgresql:dev",
  "price": {
    "cents": 0,
    "contract": false,
    "unit": "month"
  },
  "space_default": false,
  "state": "public",
  "updated_at": "2012-01-01T12:00:00Z",
  "visible": true
}

アドオンごとのプランの情報

アドオンごとの既存のプランに関する情報。

GET /addon-services/{add_on_service_id_or_name}/plans/{plan_id_or_name}

curl の例

$ curl -n https://api.heroku.com/addon-services/$ADD_ON_SERVICE_ID_OR_NAME/plans/$PLAN_ID_OR_NAME \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "addon_service": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "heroku-postgresql"
  },
  "created_at": "2012-01-01T12:00:00Z",
  "compliance": [
    "HIPAA"
  ],
  "default": false,
  "description": "Heroku Postgres Dev",
  "human_name": "Dev",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "installable_inside_private_network": false,
  "installable_outside_private_network": true,
  "name": "heroku-postgresql:dev",
  "price": {
    "cents": 0,
    "contract": false,
    "unit": "month"
  },
  "space_default": false,
  "state": "public",
  "updated_at": "2012-01-01T12:00:00Z",
  "visible": true
}

アドオンごとのプランの一覧

アドオンごとの既存のプランを一覧表示します。

Range ヘッダーの容認可能な順序の値は id または name です。

GET /addon-services/{add_on_service_id_or_name}/plans

curl の例

$ curl -n https://api.heroku.com/addon-services/$ADD_ON_SERVICE_ID_OR_NAME/plans \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: id, name
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "addon_service": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "heroku-postgresql"
    },
    "created_at": "2012-01-01T12:00:00Z",
    "compliance": [
      "HIPAA"
    ],
    "default": false,
    "description": "Heroku Postgres Dev",
    "human_name": "Dev",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "installable_inside_private_network": false,
    "installable_outside_private_network": true,
    "name": "heroku-postgresql:dev",
    "price": {
      "cents": 0,
      "contract": false,
      "unit": "month"
    },
    "space_default": false,
    "state": "public",
    "updated_at": "2012-01-01T12:00:00Z",
    "visible": true
  }
]

速度制限

安定性: 本番環境

速度制限は、各アカウントが保持するリクエストトークンの数を表します。このエンドポイントへのリクエストは速度制限のカウントに入りません。

属性

名前	型	説明	例
remaining	整数	現在の間隔に残っている許可されたリクエスト	`2399`

速度制限の情報

速度制限に関する情報。

GET /account/rate-limits

curl の例

$ curl -n https://api.heroku.com/account/rate-limits \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "remaining": 2399
}

リージョン

安定性: 本番環境

リージョンは、アプリケーションが実行される可能性のある地理的な場所を表します。

属性

名前	型	説明	例
country	文字列	リージョンが存在する国	`"United States"`
created_at	日時	リージョンが作成された日時	`"2012-01-01T12:00:00Z"`
description	文字列	リージョンの説明	`"United States"`
id	UUID	一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
locale	文字列	リージョンが存在する国の中の領域	`"Virginia"`
name	文字列	リージョンの名前	`"us"`
private_capable	ブール値	リージョンが Private Space を作成するために使用できるかどうか	`false`
provider:name	文字列	プロバイダーの名前	`"amazon-web-services"`
provider:region	文字列	プロバイダーによって使用されるリージョン名次のうちのいずれか: `"ap-south-1"`、`"eu-west-1"`、`"ap-southeast-1"`、`"ap-southeast-2"`、`"eu-central-1"`、`"eu-west-2"`、`"ap-northeast-2"`、`"ap-northeast-1"`、`"us-east-1"`、`"sa-east-1"`、`"us-west-1"`、`"us-west-2"`、`"ca-central-1"`	`"us-east-1"`
updated_at	日時	リージョンが更新された日時	`"2012-01-01T12:00:00Z"`

リージョンの情報

既存のリージョンに関する情報。

GET /regions/{region_id_or_name}

curl の例

$ curl -n https://api.heroku.com/regions/$REGION_ID_OR_NAME \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "country": "United States",
  "created_at": "2012-01-01T12:00:00Z",
  "description": "United States",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "locale": "Virginia",
  "name": "us",
  "private_capable": false,
  "provider": {
    "name": "amazon-web-services",
    "region": "us-east-1"
  },
  "updated_at": "2012-01-01T12:00:00Z"
}

リージョンの一覧

既存のリージョンを一覧表示します。

Range ヘッダーの容認可能な順序の値は id または name です。

GET /regions

curl の例

$ curl -n https://api.heroku.com/regions \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: id, name
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "country": "United States",
    "created_at": "2012-01-01T12:00:00Z",
    "description": "United States",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "locale": "Virginia",
    "name": "us",
    "private_capable": false,
    "provider": {
      "name": "amazon-web-services",
      "region": "us-east-1"
    },
    "updated_at": "2012-01-01T12:00:00Z"
  }
]

リリース

安定性: 本番環境

リリースは、Heroku 上のアプリのコード、環境設定、アドオンの組み合わせを表します。

属性

名前	型	説明	例
addon_plan_names	配列	このリリースのアプリにインストールされているアドオンプラン	`["heroku-postgresql:dev"]`
app:id	UUID	一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
app:name	文字列	アプリの名前パターン: `^[a-z][a-z0-9-]{1,28}[a-z0-9]$`	`"example"`
artifacts	配列	リリース用のビルドアーティファクト	`[{"type":"slug","id":"01234567-89ab-cdef-0123-456789abcdef"}]`
created_at	日時	リリースが作成された日時	`"2012-01-01T12:00:00Z"`
current	ブール値	このリリースがアプリの現在のリリースであるかどうか	`true`
description	文字列	このリリースでの変更の説明	`"Added new feature"`
eligible_for_rollback	ブール値	このリリースがロールバックの対象となるかどうかを示します	`true`
id	UUID	リリースの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
output_stream_url	null 許容文字列	release コマンドの出力は、ストリームとしてこの URL から入手できます。このストリームは、`text/plain` または `text/event-stream` のどちらかとして入手できます。クライアントは切断を処理できるよう準備し、`Range` ヘッダー (`text/plain` の場合) または `Last-Event-Id` ヘッダー (`text/event-stream` の場合) を送信することによってストリームを再開できます。	`"https://release-output.heroku.com/streams/01234567-89ab-cdef-0123-456789abcdef"`
slug	null 許容オブジェクト	このリリースで実行されている slug	`null`
slug:id	UUID	一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
status	文字列	リリースの現在のステータス次のうちのいずれか: `"failed"`、`"pending"`、`"succeeded"`	`"succeeded"`
updated_at	日時	リリースが更新された日時	`"2012-01-01T12:00:00Z"`
user:email	メール	一意のメールアドレス	`"username@example.com"`
user:id	UUID	アカウントの識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
version	整数	リリースに割り当てられている固有のバージョン	`11`

リリースの情報

既存のリリースに関する情報。

GET /apps/{app_id_or_name}/releases/{release_id_or_version}

curl の例

$ curl -n https://api.heroku.com/apps/$APP_ID_OR_NAME/releases/$RELEASE_ID_OR_VERSION \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "addon_plan_names": [
    "heroku-postgresql:dev"
  ],
  "artifacts": [
    {
      "type": "slug",
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    }
  ],
  "app": {
    "name": "example",
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "created_at": "2012-01-01T12:00:00Z",
  "description": "Added new feature",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "updated_at": "2012-01-01T12:00:00Z",
  "slug": {
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "status": "succeeded",
  "user": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "email": "username@example.com"
  },
  "version": 11,
  "current": true,
  "output_stream_url": "https://release-output.heroku.com/streams/01234567-89ab-cdef-0123-456789abcdef",
  "eligible_for_rollback": true
}

リリースの一覧

既存のリリースを一覧表示します。

Range ヘッダーの容認可能な順序の値は id または version です。

GET /apps/{app_id_or_name}/releases

curl の例

$ curl -n https://api.heroku.com/apps/$APP_ID_OR_NAME/releases \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: id, version
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "addon_plan_names": [
      "heroku-postgresql:dev"
    ],
    "artifacts": [
      {
        "type": "slug",
        "id": "01234567-89ab-cdef-0123-456789abcdef"
      }
    ],
    "app": {
      "name": "example",
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    },
    "created_at": "2012-01-01T12:00:00Z",
    "description": "Added new feature",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "updated_at": "2012-01-01T12:00:00Z",
    "slug": {
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    },
    "status": "succeeded",
    "user": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "email": "username@example.com"
    },
    "version": 11,
    "current": true,
    "output_stream_url": "https://release-output.heroku.com/streams/01234567-89ab-cdef-0123-456789abcdef",
    "eligible_for_rollback": true
  }
]

リリースの作成

新しいリリースを作成します。

POST /apps/{app_id_or_name}/releases

必須パラメータ

名前	型	説明	例
slug	文字列	一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`

オプションパラメータ

名前	型	説明	例
description	文字列	このリリースでの変更の説明	`"Added new feature"`
oci_image	文字列	識別子または OCI イメージのコンテンツを表す識別子	`"01234567-89ab-cdef-0123-456789abcdef"` または `"sha256:dc14ae5fbc1e7230e0a782bf216fb46500e210631703bcc6bab8acf2c6a23f42"`

curl の例

$ curl -n -X POST https://api.heroku.com/apps/$APP_ID_OR_NAME/releases \
  -d '{
  "description": "Added new feature",
  "oci_image": "01234567-89ab-cdef-0123-456789abcdef",
  "slug": "01234567-89ab-cdef-0123-456789abcdef"
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 201 Created
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "addon_plan_names": [
    "heroku-postgresql:dev"
  ],
  "artifacts": [
    {
      "type": "slug",
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    }
  ],
  "app": {
    "name": "example",
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "created_at": "2012-01-01T12:00:00Z",
  "description": "Added new feature",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "updated_at": "2012-01-01T12:00:00Z",
  "slug": {
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "status": "succeeded",
  "user": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "email": "username@example.com"
  },
  "version": 11,
  "current": true,
  "output_stream_url": "https://release-output.heroku.com/streams/01234567-89ab-cdef-0123-456789abcdef",
  "eligible_for_rollback": true
}

リリースのロールバック

既存のリリースにロールバックします。

POST /apps/{app_id_or_name}/releases

必須パラメータ

名前	型	説明	例
release	UUID	リリースの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`

curl の例

$ curl -n -X POST https://api.heroku.com/apps/$APP_ID_OR_NAME/releases \
  -d '{
  "release": "01234567-89ab-cdef-0123-456789abcdef"
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 201 Created
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "addon_plan_names": [
    "heroku-postgresql:dev"
  ],
  "artifacts": [
    {
      "type": "slug",
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    }
  ],
  "app": {
    "name": "example",
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "created_at": "2012-01-01T12:00:00Z",
  "description": "Added new feature",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "updated_at": "2012-01-01T12:00:00Z",
  "slug": {
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "status": "succeeded",
  "user": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "email": "username@example.com"
  },
  "version": 11,
  "current": true,
  "output_stream_url": "https://release-output.heroku.com/streams/01234567-89ab-cdef-0123-456789abcdef",
  "eligible_for_rollback": true
}

レビューアプリ

安定性: 本番環境

一連の変更をレビューするための一時的なアプリ。

属性

名前	型	説明	例
app	null 許容オブジェクト	このレビューアプリに関連付けられている Heroku アプリ	`null`
app:id	UUID	一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
app_setup	null 許容オブジェクト	このレビューアプリのためのアプリの設定	`null`
app_setup:id	UUID	アプリの設定の一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
branch	文字列	このレビューアプリのベースとなるリポジトリのブランチ	`"example"`
created_at	日時	テスト実行が作成された日時	`"2015-01-01T12:00:00Z"`
creator	オブジェクト	このレビューアプリを作成したユーザー
error_status	null 許容文字列	レビューアプリの作成からのエラーメッセージ (存在する場合)	`null`
fork_repo	null 許容オブジェクト		`null`
fork_repo:id	null 許容整数	ブランチが存在するフォークのリポジトリ ID	`"123456"`
id	UUID	このレビューアプリの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
message	null 許容文字列	レビューアプリの作成からのメッセージ (存在する場合)	`null`
pipeline:id	UUID	パイプラインの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
pr_number	null 許容整数	このレビューアプリがビルトされるときのプルリクエスト番号	`24`
status	文字列	このレビューアプリの現在の状態次のうちのいずれか: `"pending"`、`"creating"`、`"created"`、`"deleting"`、`"deleted"`、`"errored"`	`"pending"`
updated_at	日時	レビューアプリが更新された日時	`"2015-01-01T12:00:00Z"`
wait_for_ci	ブール値	アプリをビルドする前に CI を待つかどうか	`true`

レビューアプリの作成

新しいレビューアプリを作成します。

POST /review-apps

必須パラメータ

名前	型	説明	例
branch	文字列	このレビューアプリのベースとなるリポジトリのブランチ	`"example"`
pipeline	UUID	パイプラインの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
source_blob:url	文字列	ビルドのためのソースコードの gzip で圧縮された tar アーカイブがダウンロードされた URL	`"https://example.com/source.tgz?token=xyz"`
source_blob:version	null 許容文字列	ビルドするコードのバージョン番号 (または SHA)	`"v1.2.0"`

オプションパラメータ

名前	型	説明	例
environment	null 許容オブジェクト	生成されたレビューアプリプロセスの環境に設定される一連のキー値ペア。	`{"FOO":"bar","BAZ":"qux"}`
fork_repo_id	null 許容整数	ブランチが存在するフォークのリポジトリ ID	`"123456"`
pr_number	null 許容整数	このレビューアプリがビルトされるときのプルリクエスト番号	`24`

curl の例

$ curl -n -X POST https://api.heroku.com/review-apps \
  -d '{
  "branch": "example",
  "pr_number": 24,
  "pipeline": "01234567-89ab-cdef-0123-456789abcdef",
  "source_blob": {
    "url": "https://example.com/source.tgz?token=xyz",
    "version": "v1.2.0"
  },
  "environment": {
    "FOO": "bar",
    "BAZ": "qux"
  },
  "fork_repo_id": "123456"
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 201 Created
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "app": {
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "app_setup": {
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "branch": "example",
  "created_at": "2015-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "pipeline": {
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "status": "pending",
  "updated_at": "2015-01-01T12:00:00Z",
  "creator": null,
  "wait_for_ci": true,
  "error_status": "example",
  "message": "example",
  "fork_repo": {
    "id": "123456"
  },
  "pr_number": 24
}

レビューアプリの取得

既存のレビューアプリを取得します。

GET /review-apps/{review_app_id}

curl の例

$ curl -n https://api.heroku.com/review-apps/$REVIEW_APP_ID \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "app": {
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "app_setup": {
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "branch": "example",
  "created_at": "2015-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "pipeline": {
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "status": "pending",
  "updated_at": "2015-01-01T12:00:00Z",
  "creator": null,
  "wait_for_ci": true,
  "error_status": "example",
  "message": "example",
  "fork_repo": {
    "id": "123456"
  },
  "pr_number": 24
}

レビューアプリの削除

既存のレビューアプリを削除します。

DELETE /review-apps/{review_app_id}

curl の例

$ curl -n -X DELETE https://api.heroku.com/review-apps/$REVIEW_APP_ID \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "app": {
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "app_setup": {
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "branch": "example",
  "created_at": "2015-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "pipeline": {
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "status": "pending",
  "updated_at": "2015-01-01T12:00:00Z",
  "creator": null,
  "wait_for_ci": true,
  "error_status": "example",
  "message": "example",
  "fork_repo": {
    "id": "123456"
  },
  "pr_number": 24
}

app_id ごとのレビューアプリの取得

関連付けられている app_id を使用してレビューアプリを取得します。

GET /apps/{app_id_or_name}/review-app

curl の例

$ curl -n https://api.heroku.com/apps/$APP_ID_OR_NAME/review-app \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "app": {
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "app_setup": {
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "branch": "example",
  "created_at": "2015-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "pipeline": {
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "status": "pending",
  "updated_at": "2015-01-01T12:00:00Z",
  "creator": null,
  "wait_for_ci": true,
  "error_status": "example",
  "message": "example",
  "fork_repo": {
    "id": "123456"
  },
  "pr_number": 24
}

レビューアプリの一覧

パイプラインのレビューアプリを一覧表示します。

Range ヘッダーの唯一の容認可能な順序の値は id です。

GET /pipelines/{pipeline_id}/review-apps

curl の例

$ curl -n https://api.heroku.com/pipelines/$PIPELINE_ID/review-apps \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: id
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "app": {
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    },
    "app_setup": {
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    },
    "branch": "example",
    "created_at": "2015-01-01T12:00:00Z",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "pipeline": {
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    },
    "status": "pending",
    "updated_at": "2015-01-01T12:00:00Z",
    "creator": null,
    "wait_for_ci": true,
    "error_status": "example",
    "message": "example",
    "fork_repo": {
      "id": "123456"
    },
    "pr_number": 24
  }
]

レビューアプリの設定

安定性: 本番環境

レビューアプリは、パイプラインに対して設定できます。

属性

名前	型	説明	例
automatic_review_apps	ブール値	プルリクエストに対する自動レビューアプリを有効にするかどうか	`true`
base_name	null 許容文字列	レビューアプリ名を作成するために使用される一意のプレフィックス	`"singular-app"`
deploy_target	null 許容オブジェクト	パイプラインのレビューアプリのデプロイターゲット	`null`
deploy_target:id	文字列	デプロイターゲットの一意識別子パターン: `(^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$\|^[a-z]{2}$)`	`"us"`
deploy_target:type	文字列	デプロイターゲットのタイプパターン: `(^space$\|^region$)`	`"region"`
destroy_stale_apps	ブール値	数日間デプロイされていないレビューアプリを自動的に破棄するかどうか	`true`
pipeline_id	UUID	パイプラインの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
repo:id	整数	リポジトリ ID	`"123456"`
stale_days	整数	レビューアプリを古いと見なすまでのデプロイなしの日数	`"5"`
wait_for_ci	ブール値	true の場合、レビューアプリは CI が渡されたときにのみ作成されます。	`true`

レビューアプリの設定の有効化

パイプラインのレビューアプリを有効にします。

POST /pipelines/{pipeline_id}/review-app-config

必須パラメータ

名前	型	説明	例
repo	文字列	レビューアプリを有効にするときの元のリポジトリのフルネーム	`"heroku/homebrew-brew"`

オプションパラメータ

名前	型	説明	例
automatic_review_apps	ブール値	true の場合は、リポジトリでプルリクエストが開かれたときにレビューアプリの作成がトリガーされます。	`true`
base_name	null 許容文字列	レビューアプリ名を作成するために使用される一意のプレフィックス	`"singular-app"`
deploy_target	null 許容オブジェクト	Common Runtime または Private Space のどちらを使用するかを指定するキー値ペアを提供します。	`null`
deploy_target:id	文字列	デプロイターゲットの一意識別子パターン: `(^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$\|^[a-z]{2}$)`	`"us"`
deploy_target:type	文字列	デプロイターゲットのタイプパターン: `(^space$\|^region$)`	`"region"`
destroy_stale_apps	ブール値	true の場合は、古くなったレビューアプリの自動削除がトリガーされます。	`true`
stale_days	整数	destroy_stale_apps が true である場合、アプリはこの日数の後に破棄されます。	`"5"`
wait_for_ci	ブール値	true の場合、レビューアプリは CI が渡されたときにのみ作成されます。	`true`

curl の例

$ curl -n -X POST https://api.heroku.com/pipelines/$PIPELINE_ID/review-app-config \
  -d '{
  "repo": "heroku/homebrew-brew",
  "automatic_review_apps": true,
  "destroy_stale_apps": true,
  "stale_days": "5",
  "deploy_target": {
    "id": "us",
    "type": "region"
  },
  "wait_for_ci": true,
  "base_name": "singular-app"
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 201 Created
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "repo": {
    "id": "123456"
  },
  "automatic_review_apps": true,
  "deploy_target": {
    "id": "us",
    "type": "region"
  },
  "destroy_stale_apps": true,
  "stale_days": "5",
  "pipeline_id": "01234567-89ab-cdef-0123-456789abcdef",
  "wait_for_ci": true,
  "base_name": "singular-app"
}

レビューアプリの設定の情報

パイプラインのレビューアプリの設定を取得します。

GET /pipelines/{pipeline_id}/review-app-config

curl の例

$ curl -n https://api.heroku.com/pipelines/$PIPELINE_ID/review-app-config \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "repo": {
    "id": "123456"
  },
  "automatic_review_apps": true,
  "deploy_target": {
    "id": "us",
    "type": "region"
  },
  "destroy_stale_apps": true,
  "stale_days": "5",
  "pipeline_id": "01234567-89ab-cdef-0123-456789abcdef",
  "wait_for_ci": true,
  "base_name": "singular-app"
}

レビューアプリの設定の更新

パイプラインのレビューアプリの設定を更新します。

PATCH /pipelines/{pipeline_id}/review-app-config

オプションパラメータ

名前	型	説明	例
automatic_review_apps	ブール値	true の場合は、リポジトリでプルリクエストが開かれたときにレビューアプリの作成がトリガーされます。	`true`
base_name	null 許容文字列	レビューアプリ名を作成するために使用される一意のプレフィックス	`"singular-app"`
deploy_target	null 許容オブジェクト	Common Runtime または Private Space のどちらを使用するかを指定するキー値ペアを提供します。	`null`
deploy_target:id	文字列	デプロイターゲットの一意識別子パターン: `(^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$\|^[a-z]{2}$)`	`"us"`
deploy_target:type	文字列	デプロイターゲットのタイプパターン: `(^space$\|^region$)`	`"region"`
destroy_stale_apps	ブール値	true の場合は、古くなったレビューアプリの自動削除がトリガーされます。	`true`
stale_days	整数	destroy_stale_apps が true である場合、アプリはこの日数の後に破棄されます。	`"5"`
wait_for_ci	ブール値	true の場合、レビューアプリは CI が渡されたときにのみ作成されます。	`true`

curl の例

$ curl -n -X PATCH https://api.heroku.com/pipelines/$PIPELINE_ID/review-app-config \
  -d '{
  "automatic_review_apps": true,
  "destroy_stale_apps": true,
  "stale_days": "5",
  "deploy_target": {
    "id": "us",
    "type": "region"
  },
  "wait_for_ci": true,
  "base_name": "singular-app"
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "repo": {
    "id": "123456"
  },
  "automatic_review_apps": true,
  "deploy_target": {
    "id": "us",
    "type": "region"
  },
  "destroy_stale_apps": true,
  "stale_days": "5",
  "pipeline_id": "01234567-89ab-cdef-0123-456789abcdef",
  "wait_for_ci": true,
  "base_name": "singular-app"
}

レビューアプリの設定の削除

パイプラインのレビューアプリを無効にします。

DELETE /pipelines/{pipeline_id}/review-app-config

curl の例

$ curl -n -X DELETE https://api.heroku.com/pipelines/$PIPELINE_ID/review-app-config \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "repo": {
    "id": "123456"
  },
  "automatic_review_apps": true,
  "deploy_target": {
    "id": "us",
    "type": "region"
  },
  "destroy_stale_apps": true,
  "stale_days": "5",
  "pipeline_id": "01234567-89ab-cdef-0123-456789abcdef",
  "wait_for_ci": true,
  "base_name": "singular-app"
}

slug

安定性: 本番環境

slug は、プラットフォーム上で実行する準備ができているアプリケーションコードのスナップショットです。

属性

名前	型	説明	例
blob:method	文字列	slug BLOB を操作するために使用されるメソッド	`"GET"`
blob:url	文字列	slug BLOB を操作するための URL	`"https://api.heroku.com/slugs/1234.tgz"`
buildpack_provided_description	null 許容文字列	slug の buildpack からの説明	`"Ruby/Rack"`
checksum	null 許容文字列	その完全性を確認するための slug のオプションのチェックサム	`"SHA256:e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"`
commit	null 許容文字列	バージョン管理システムによるコードの識別 (Git HEAD の SHA など)	`"60883d9e8947a57e04dc9124f25df004866a2051"`
commit_description	null 許容文字列	提供されたコミットのオプションの説明	`"fixed a bug with API documentation"`
created_at	日時	slug が作成された日時	`"2012-01-01T12:00:00Z"`
id	UUID	一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
process_types	オブジェクト	プロセスタイプ名から対応するコマンドへのハッシュマッピング	`{"web":"./bin/web -p $PORT"}`
size	null 許容整数	slug のサイズ (バイト単位)	`2048`
stack:id	UUID	スタックの識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
stack:name	文字列	一意の名前	`"heroku-18"`
updated_at	日時	slug が更新された日時	`"2012-01-01T12:00:00Z"`

slug の情報

既存の slug に関する情報。

GET /apps/{app_id_or_name}/slugs/{slug_id}

curl の例

$ curl -n https://api.heroku.com/apps/$APP_ID_OR_NAME/slugs/$SLUG_ID \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "blob": {
    "method": "GET",
    "url": "https://api.heroku.com/slugs/1234.tgz"
  },
  "buildpack_provided_description": "Ruby/Rack",
  "checksum": "SHA256:e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
  "commit": "60883d9e8947a57e04dc9124f25df004866a2051",
  "commit_description": "fixed a bug with API documentation",
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "process_types": {
    "web": "./bin/web -p $PORT"
  },
  "size": 2048,
  "stack": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "heroku-18"
  },
  "updated_at": "2012-01-01T12:00:00Z"
}

slug の作成

新しい slug を作成します。詳細は、「Deploying Slugs using the Platform API」(Platform API を使用した slug のデプロイ) を参照してください。

POST /apps/{app_id_or_name}/slugs

必須パラメータ

名前	型	説明	例
process_types	オブジェクト	プロセスタイプ名から対応するコマンドへのハッシュマッピング	`{"web":"./bin/web -p $PORT"}`

オプションパラメータ

名前	型	説明	例
buildpack_provided_description	null 許容文字列	slug の buildpack からの説明	`"Ruby/Rack"`
checksum	null 許容文字列	その完全性を確認するための slug のオプションのチェックサム	`"SHA256:e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"`
commit	null 許容文字列	バージョン管理システムによるコードの識別 (Git HEAD の SHA など)	`"60883d9e8947a57e04dc9124f25df004866a2051"`
commit_description	null 許容文字列	提供されたコミットのオプションの説明	`"fixed a bug with API documentation"`
stack	文字列	スタックの一意の名前または識別子	`"heroku-18"` または `"01234567-89ab-cdef-0123-456789abcdef"`

curl の例

$ curl -n -X POST https://api.heroku.com/apps/$APP_ID_OR_NAME/slugs \
  -d '{
  "buildpack_provided_description": "Ruby/Rack",
  "checksum": "SHA256:e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
  "commit": "60883d9e8947a57e04dc9124f25df004866a2051",
  "commit_description": "fixed a bug with API documentation",
  "process_types": {
    "web": "./bin/web -p $PORT"
  },
  "stack": "01234567-89ab-cdef-0123-456789abcdef"
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 201 Created
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "blob": {
    "method": "PUT",
    "url": "https://api.heroku.com/slugs/1234.tgz"
  },
  "buildpack_provided_description": "Ruby/Rack",
  "checksum": "SHA256:e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
  "commit": "60883d9e8947a57e04dc9124f25df004866a2051",
  "commit_description": "fixed a bug with API documentation",
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "process_types": {
    "web": "./bin/web -p $PORT"
  },
  "size": 2048,
  "stack": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "heroku-18"
  },
  "updated_at": "2012-01-01T12:00:00Z"
}

SMS の番号

安定性: 本番環境

SMS の番号は、2 要素認証が有効になっているアカウントのリカバリに使用されます。

属性

名前	型	説明	例
sms_number	null 許容文字列	アカウントの SMS の番号	`"+1 *-*-1234"`

SMS の番号

SMS リカバリコードを使用してアカウントを復旧します。

GET /users/{account_email_or_id_or_self}/sms-number

curl の例

$ curl -n https://api.heroku.com/users/$ACCOUNT_EMAIL_OR_ID_OR_SELF/sms-number \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "sms_number": "+1 ***-***-1234"
}

SMS の番号の復旧

SMS リカバリコードを使用してアカウントを復旧します。

POST /users/{account_email_or_id_or_self}/sms-number/actions/recover

curl の例

$ curl -n -X POST https://api.heroku.com/users/$ACCOUNT_EMAIL_OR_ID_OR_SELF/sms-number/actions/recover \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "sms_number": "+1 ***-***-1234"
}

SMS の番号の確認

確認コードを使用して SMS の番号の変更を確認します。

POST /users/{account_email_or_id_or_self}/sms-number/actions/confirm

curl の例

$ curl -n -X POST https://api.heroku.com/users/$ACCOUNT_EMAIL_OR_ID_OR_SELF/sms-number/actions/confirm \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "sms_number": "+1 ***-***-1234"
}

SNI エンドポイント

安定性: 開発

SNI エンドポイントは、Heroku アプリへの (SNI TLS 拡張機能を使用した) HTTPS トラフィックのカスタム SSL 証明書を処理するパブリックアドレスです。

属性

名前	型	説明	例
app:id	UUID	一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
app:name	文字列	アプリの名前パターン: `^[a-z][a-z0-9-]{1,28}[a-z0-9]$`	`"example"`
certificate_chain	文字列	パブリック証明書チェーンの生のコンテンツ (.crt または .pem ファイルなど)	`"-----BEGIN CERTIFICATE----- ..."`
created_at	日時	エンドポイントが作成された日時	`"2012-01-01T12:00:00Z"`
display_name	null 許容文字列	SSL 証明書の一意の名前パターン: `^[a-z][a-z0-9-]{2,29}$`	`"example"`
domains	配列	この SSL 証明書に関連付けられているドメイン	`["01234567-89ab-cdef-0123-456789abcdef"]`
id	UUID	この SNI エンドポイントの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
name	文字列	SNI エンドポイントの一意の名前パターン: `^[a-z][a-z0-9-]{2,29}$`	`"example"`
ssl_cert:ca_signed?	ブール値		`true`
ssl_cert:cert_domains	配列
ssl_cert:expires_at	日時		`"2015-01-01T12:00:00Z"`
ssl_cert:id	UUID	この SSL 証明書の一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
ssl_cert:issuer	文字列		`"example"`
ssl_cert:self_signed?	ブール値		`true`
ssl_cert:starts_at	日時		`"2015-01-01T12:00:00Z"`
ssl_cert:subject	文字列		`"example"`
updated_at	日時	SNI エンドポイントが更新された日時	`"2012-01-01T12:00:00Z"`

SNI エンドポイントの作成

新しい SNI エンドポイントを作成します。

POST /apps/{app_id_or_name}/sni-endpoints

必須パラメータ

名前	型	説明	例
certificate_chain	文字列	パブリック証明書チェーンの生のコンテンツ (.crt または .pem ファイルなど)	`"-----BEGIN CERTIFICATE----- ..."`
private_key	文字列	秘密鍵のコンテンツ (.key ファイルなど)	`"-----BEGIN RSA PRIVATE KEY----- ..."`

curl の例

$ curl -n -X POST https://api.heroku.com/apps/$APP_ID_OR_NAME/sni-endpoints \
  -d '{
  "certificate_chain": "-----BEGIN CERTIFICATE----- ...",
  "private_key": "-----BEGIN RSA PRIVATE KEY----- ..."
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 201 Created
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "certificate_chain": "-----BEGIN CERTIFICATE----- ...",
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "name": "example",
  "updated_at": "2012-01-01T12:00:00Z",
  "display_name": "example",
  "domains": [
    "01234567-89ab-cdef-0123-456789abcdef"
  ],
  "app": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  },
  "ssl_cert": {
    "ca_signed?": true,
    "cert_domains": null,
    "expires_at": "2015-01-01T12:00:00Z",
    "issuer": "example",
    "self_signed?": true,
    "starts_at": "2015-01-01T12:00:00Z",
    "subject": "example",
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  }
}

SNI エンドポイントの削除

既存の SNI エンドポイントを削除します。

DELETE /apps/{app_id_or_name}/sni-endpoints/{sni_endpoint_id_or_name}

curl の例

$ curl -n -X DELETE https://api.heroku.com/apps/$APP_ID_OR_NAME/sni-endpoints/$SNI_ENDPOINT_ID_OR_NAME \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "certificate_chain": "-----BEGIN CERTIFICATE----- ...",
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "name": "example",
  "updated_at": "2012-01-01T12:00:00Z",
  "display_name": "example",
  "domains": [
    "01234567-89ab-cdef-0123-456789abcdef"
  ],
  "app": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  },
  "ssl_cert": {
    "ca_signed?": true,
    "cert_domains": null,
    "expires_at": "2015-01-01T12:00:00Z",
    "issuer": "example",
    "self_signed?": true,
    "starts_at": "2015-01-01T12:00:00Z",
    "subject": "example",
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  }
}

SNI エンドポイントの情報

既存の SNI エンドポイントに関する情報。

GET /apps/{app_id_or_name}/sni-endpoints/{sni_endpoint_id_or_name}

curl の例

$ curl -n https://api.heroku.com/apps/$APP_ID_OR_NAME/sni-endpoints/$SNI_ENDPOINT_ID_OR_NAME \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "certificate_chain": "-----BEGIN CERTIFICATE----- ...",
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "name": "example",
  "updated_at": "2012-01-01T12:00:00Z",
  "display_name": "example",
  "domains": [
    "01234567-89ab-cdef-0123-456789abcdef"
  ],
  "app": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  },
  "ssl_cert": {
    "ca_signed?": true,
    "cert_domains": null,
    "expires_at": "2015-01-01T12:00:00Z",
    "issuer": "example",
    "self_signed?": true,
    "starts_at": "2015-01-01T12:00:00Z",
    "subject": "example",
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  }
}

SNI エンドポイントの一覧

既存の SNI エンドポイントを一覧表示します。

Range ヘッダーの容認可能な順序の値は id または name です。

GET /apps/{app_id_or_name}/sni-endpoints

curl の例

$ curl -n https://api.heroku.com/apps/$APP_ID_OR_NAME/sni-endpoints \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: id, name
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "certificate_chain": "-----BEGIN CERTIFICATE----- ...",
    "created_at": "2012-01-01T12:00:00Z",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example",
    "updated_at": "2012-01-01T12:00:00Z",
    "display_name": "example",
    "domains": [
      "01234567-89ab-cdef-0123-456789abcdef"
    ],
    "app": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "example"
    },
    "ssl_cert": {
      "ca_signed?": true,
      "cert_domains": null,
      "expires_at": "2015-01-01T12:00:00Z",
      "issuer": "example",
      "self_signed?": true,
      "starts_at": "2015-01-01T12:00:00Z",
      "subject": "example",
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    }
  }
]

SNI エンドポイントの更新

既存の SNI エンドポイントを更新します。

PATCH /apps/{app_id_or_name}/sni-endpoints/{sni_endpoint_id_or_name}

必須パラメータ

名前	型	説明	例
certificate_chain	文字列	パブリック証明書チェーンの生のコンテンツ (.crt または .pem ファイルなど)	`"-----BEGIN CERTIFICATE----- ..."`
private_key	文字列	秘密鍵のコンテンツ (.key ファイルなど)	`"-----BEGIN RSA PRIVATE KEY----- ..."`

curl の例

$ curl -n -X PATCH https://api.heroku.com/apps/$APP_ID_OR_NAME/sni-endpoints/$SNI_ENDPOINT_ID_OR_NAME \
  -d '{
  "certificate_chain": "-----BEGIN CERTIFICATE----- ...",
  "private_key": "-----BEGIN RSA PRIVATE KEY----- ..."
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "certificate_chain": "-----BEGIN CERTIFICATE----- ...",
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "name": "example",
  "updated_at": "2012-01-01T12:00:00Z",
  "display_name": "example",
  "domains": [
    "01234567-89ab-cdef-0123-456789abcdef"
  ],
  "app": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  },
  "ssl_cert": {
    "ca_signed?": true,
    "cert_domains": null,
    "expires_at": "2015-01-01T12:00:00Z",
    "issuer": "example",
    "self_signed?": true,
    "starts_at": "2015-01-01T12:00:00Z",
    "subject": "example",
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  }
}

ソース

安定性: 本番環境

ソースは、アプリケーションのソースコードをアップロードおよびダウンロードするための場所です。

属性

名前	型	説明	例
source_blob:get_url	文字列	ソースをダウンロードするための URL	`"https://api.heroku.com/sources/1234.tgz"`
source_blob:put_url	文字列	ソースをアップロードするための URL	`"https://api.heroku.com/sources/1234.tgz"`

ソースの作成

ソースをアップロードおよびダウンロードするための URL を作成します。

POST /sources

curl の例

$ curl -n -X POST https://api.heroku.com/sources \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 201 Created
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "source_blob": {
    "get_url": "https://api.heroku.com/sources/1234.tgz",
    "put_url": "https://api.heroku.com/sources/1234.tgz"
  }
}

ソースの作成 - 非推奨

ソースをアップロードおよびダウンロードするための URL を作成します。非推奨であり、代わりに POST /sources が推奨されています。

POST /apps/{app_id_or_name}/sources

curl の例

$ curl -n -X POST https://api.heroku.com/apps/$APP_ID_OR_NAME/sources \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 201 Created
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "source_blob": {
    "get_url": "https://api.heroku.com/sources/1234.tgz",
    "put_url": "https://api.heroku.com/sources/1234.tgz"
  }
}

Space

安定性: 本番環境

Space は、分離された、可用性の高い、安全なアプリ実行環境です。

属性

名前	型	説明	例
cidr	文字列	Private Space が使用する RFC-1918 CIDR。これは、10.0.0.0/8、172.16.0.0/12、または 192.168.0.0/16 では /16 である必要があります。デフォルト値: `"10.0.0.0/16"` パターン: `^((?:10\|172.(?:1[6-9]\|2[0-9]\|3[01])\|192.168)..*.+\/16)$`	`"172.20.20.30/16"`
created_at	日時	Space が作成された日時	`"2012-01-01T12:00:00Z"`
data_cidr	文字列	Heroku Data アドオンを使用しているときに自動的に作成される Heroku で管理されるピアリング接続のために Private Space が使用する RFC-1918 CIDR。これは、/16 ～ /20 である必要があります。	`"10.2.0.0/16"`
generation:id	UUID	このスペースの Heroku プラットフォームの世代の一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
generation:name	文字列	このスペースの Heroku プラットフォームの世代の一意の名前	`"cedar"`
id	UUID	Space の一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
name	文字列	Space の一意の名前パターン: `^[a-z0-9](?:[a-z0-9]\|-(?!-))+[a-z0-9]$`	`"nasa"`
organization:name	文字列	チームの一意の名前	`"example"`
region:id	UUID	一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
region:name	文字列	リージョンの名前	`"us"`
shield	ブール値	この Space で Shield が有効になっている場合は true	`true`
state	文字列	この Space の可用性次のうちのいずれか: `"allocating"`、`"allocated"`、`"deleting"`	`"allocated"`
team:id	UUID	チームの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
team:name	文字列	チームの一意の名前	`"example"`
updated_at	日時	Space が更新された日時	`"2012-01-01T12:00:00Z"`

Space の一覧

既存の Space を一覧表示します。

Range ヘッダーの容認可能な順序の値は id または name です。

GET /spaces

curl の例

$ curl -n https://api.heroku.com/spaces \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: id, name
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "created_at": "2012-01-01T12:00:00Z",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "nasa",
    "organization": {
      "name": "example"
    },
    "team": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "example"
    },
    "region": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "us"
    },
    "shield": true,
    "state": "allocated",
    "updated_at": "2012-01-01T12:00:00Z",
    "cidr": "172.20.20.30/16",
    "data_cidr": "10.2.0.0/16",
    "generation": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "cedar"
    }
  }
]

Space の情報

既存の Space に関する情報。

GET /spaces/{space_id_or_name}

curl の例

$ curl -n https://api.heroku.com/spaces/$SPACE_ID_OR_NAME \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "name": "nasa",
  "organization": {
    "name": "example"
  },
  "team": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  },
  "region": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "us"
  },
  "shield": true,
  "state": "allocated",
  "updated_at": "2012-01-01T12:00:00Z",
  "cidr": "172.20.20.30/16",
  "data_cidr": "10.2.0.0/16",
  "generation": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "cedar"
  }
}

Space の更新

既存の Space を更新します。

PATCH /spaces/{space_id_or_name}

オプションパラメータ

名前	型	説明	例
name	文字列	Space の一意の名前パターン: `^[a-z0-9](?:[a-z0-9]\|-(?!-))+[a-z0-9]$`	`"nasa"`

curl の例

$ curl -n -X PATCH https://api.heroku.com/spaces/$SPACE_ID_OR_NAME \
  -d '{
  "name": "nasa"
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "name": "nasa",
  "organization": {
    "name": "example"
  },
  "team": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  },
  "region": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "us"
  },
  "shield": true,
  "state": "allocated",
  "updated_at": "2012-01-01T12:00:00Z",
  "cidr": "172.20.20.30/16",
  "data_cidr": "10.2.0.0/16",
  "generation": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "cedar"
  }
}

Space の削除

既存の Space を削除します。

DELETE /spaces/{space_id_or_name}

curl の例

$ curl -n -X DELETE https://api.heroku.com/spaces/$SPACE_ID_OR_NAME \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "name": "nasa",
  "organization": {
    "name": "example"
  },
  "team": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  },
  "region": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "us"
  },
  "shield": true,
  "state": "allocated",
  "updated_at": "2012-01-01T12:00:00Z",
  "cidr": "172.20.20.30/16",
  "data_cidr": "10.2.0.0/16",
  "generation": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "cedar"
  }
}

Space の作成

新しい Space を作成します。

POST /spaces

必須パラメータ

名前	型	説明	例
name	文字列	Space の一意の名前パターン: `^[a-z0-9](?:[a-z0-9]\|-(?!-))+[a-z0-9]$`	`"nasa"`
team	文字列	チームの一意の名前	`"example"`

オプションパラメータ

名前	型	説明	例
cidr	文字列	Private Space が使用する RFC-1918 CIDR。これは、10.0.0.0/8、172.16.0.0/12、または 192.168.0.0/16 では /16 である必要があります。デフォルト値: `"10.0.0.0/16"` パターン: `^((?:10\|172.(?:1[6-9]\|2[0-9]\|3[01])\|192.168)..*.+\/16)$`	`"172.20.20.30/16"`
data_cidr	文字列	Heroku Data アドオンを使用しているときに自動的に作成される Heroku で管理されるピアリング接続のために Private Space が使用する RFC-1918 CIDR。これは、/16 ～ /20 である必要があります。	`"10.2.0.0/16"`
generation	文字列	このスペースの Heroku プラットフォームの世代の一意の名前	`"cedar"`
log_drain_url	文字列	すべてのアプリがログをドレインする URL。スペースの作成中にのみ設定可能で、直接ログ記録を可能にします。HTTPS を使用する必要があります。	`"https://example.com/logs"`
region	文字列	リージョンの一意識別子または名前	`"01234567-89ab-cdef-0123-456789abcdef"` または `"us"`
shield	ブール値	この Space で Shield が有効になっている場合は true	`true`

curl の例

$ curl -n -X POST https://api.heroku.com/spaces \
  -d '{
  "name": "nasa",
  "team": "example",
  "region": "01234567-89ab-cdef-0123-456789abcdef",
  "shield": true,
  "cidr": "172.20.20.30/16",
  "data_cidr": "10.2.0.0/16",
  "log_drain_url": "https://example.com/logs",
  "generation": "cedar"
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 201 Created
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "name": "nasa",
  "organization": {
    "name": "example"
  },
  "team": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  },
  "region": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "us"
  },
  "shield": true,
  "state": "allocated",
  "updated_at": "2012-01-01T12:00:00Z",
  "cidr": "172.20.20.30/16",
  "data_cidr": "10.2.0.0/16",
  "generation": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "cedar"
  }
}

Space アクセス

安定性: プロトタイプ

Space アクセスは、特定の Space に対する特定のユーザーのアクセス許可を表します。

属性

名前	型	説明	例
created_at	日時	Space が作成された日時	`"2012-01-01T12:00:00Z"`
id	UUID	Space の一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
permissions/description	文字列		`"example"`
permissions/name	文字列		`"example"`
space:id	UUID	一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
space:name	文字列	アプリの名前パターン: `^[a-z][a-z0-9-]{1,28}[a-z0-9]$`	`"example"`
updated_at	日時	Space が更新された日時	`"2012-01-01T12:00:00Z"`
user:email	メール	一意のメールアドレス	`"username@example.com"`
user:id	UUID	アカウントの識別子	`"01234567-89ab-cdef-0123-456789abcdef"`

Space アクセスの情報

特定の Space に対する特定のユーザーのアクセス許可を一覧表示します。

GET /spaces/{space_id_or_name}/members/{account_email_or_id_or_self}

curl の例

$ curl -n https://api.heroku.com/spaces/$SPACE_ID_OR_NAME/members/$ACCOUNT_EMAIL_OR_ID_OR_SELF \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "space": {
    "name": "example",
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "permissions": [
    {
      "description": "example",
      "name": "example"
    }
  ],
  "updated_at": "2012-01-01T12:00:00Z",
  "user": {
    "email": "username@example.com",
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  }
}

Space アクセスの更新

Space に対する既存のユーザーの一連のアクセス許可を更新します。

PATCH /spaces/{space_id_or_name}/members/{account_email_or_id_or_self}

必須パラメータ

名前	型	説明	例
permissions/name	文字列		`"example"`

curl の例

$ curl -n -X PATCH https://api.heroku.com/spaces/$SPACE_ID_OR_NAME/members/$ACCOUNT_EMAIL_OR_ID_OR_SELF \
  -d '{
  "permissions": [
    {
      "name": "example"
    }
  ]
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "space": {
    "name": "example",
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "permissions": [
    {
      "description": "example",
      "name": "example"
    }
  ],
  "updated_at": "2012-01-01T12:00:00Z",
  "user": {
    "email": "username@example.com",
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  }
}

Space アクセスの一覧

すべてのユーザーと Space に対する各ユーザーのアクセス許可を一覧表示します。

Range ヘッダーの唯一の容認可能な順序の値は id です。

GET /spaces/{space_id_or_name}/members

curl の例

$ curl -n https://api.heroku.com/spaces/$SPACE_ID_OR_NAME/members \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: id
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "space": {
      "name": "example",
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    },
    "created_at": "2012-01-01T12:00:00Z",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "permissions": [
      {
        "description": "example",
        "name": "example"
      }
    ],
    "updated_at": "2012-01-01T12:00:00Z",
    "user": {
      "email": "username@example.com",
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    }
  }
]

Space のネットワークアドレス変換

安定性: プロトタイプ

Space からの固定アウトバウンド IP アドレスに対するネットワークアドレス変換 (NAT)

属性

名前	型	説明	例
created_at	日時	Space のネットワークアドレス変換が作成された日時	`"2012-01-01T12:00:00Z"`
sources	配列	アウトバウンドネットワークトラフィックの発信元になる可能性がある IP	`["123.123.123.123"]`
state	文字列	Space のネットワークアドレス変換の可用性次のうちのいずれか: `"disabled"`、`"updating"`、`"enabled"`	`"enabled"`
updated_at	日時	Space のネットワークアドレス変換が更新された日時	`"2012-01-01T12:00:00Z"`

Space のネットワークアドレス変換の情報

Space のネットワークアドレス変換の現在の状態。

GET /spaces/{space_id_or_name}/nat

curl の例

$ curl -n https://api.heroku.com/spaces/$SPACE_ID_OR_NAME/nat \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "created_at": "2012-01-01T12:00:00Z",
  "sources": [
    "123.123.123.123"
  ],
  "state": "enabled",
  "updated_at": "2012-01-01T12:00:00Z"
}

Space トポロジー

安定性: プロトタイプ

Space トポロジーは、Space のすべての実行中の dyno、フォーメーション、アプリケーションを表示するためのメカニズムを提供します。これは、DNS Service Discovery を機能強化するために使用されるものと同じデータです。

属性

名前	型	説明	例
apps/domains	配列		`["example.com","example.net"]`
apps/formation	配列	アプリケーションのフォーメーション	`[{"id":"01234567-89ab-cdef-0123-456789abcdef","process_type":"web","dynos":[{"id":"01234567-89ab-cdef-0123-456789abcdef","number":1,"private_ip":"10.0.134.42","hostname":"1.example-app-90210.app.localspace"}]}]`
apps/id	UUID	一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
version	整数	Space トポロジーのペイロードのバージョン	`1`

Space トポロジー

現在の Space トポロジー

GET /spaces/{space_id_or_name}/topology

curl の例

$ curl -n https://api.heroku.com/spaces/$SPACE_ID_OR_NAME/topology \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "version": 1,
  "apps": [
    {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "domains": [
        "example.com",
        "example.net"
      ],
      "formation": [
        {
          "id": "01234567-89ab-cdef-0123-456789abcdef",
          "process_type": "web",
          "dynos": [
            {
              "id": "01234567-89ab-cdef-0123-456789abcdef",
              "number": 1,
              "private_ip": "10.0.134.42",
              "hostname": "1.example-app-90210.app.localspace"
            }
          ]
        }
      ]
    }
  ]
}

Space の転送

安定性: 開発

同じエンタープライズアカウントを持つエンタープライズチーム間で Space を転送します。

Space の転送

エンタープライズチーム間で Space を転送します。

POST /spaces/{space_id_or_name}/transfer

必須パラメータ

名前	型	説明	例
new_owner	文字列	チームの一意の名前	`"example"`

curl の例

$ curl -n -X POST https://api.heroku.com/spaces/$SPACE_ID_OR_NAME/transfer \
  -d '{
  "new_owner": "example"
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "name": "nasa",
  "organization": {
    "name": "example"
  },
  "team": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  },
  "region": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "us"
  },
  "shield": true,
  "state": "allocated",
  "updated_at": "2012-01-01T12:00:00Z",
  "cidr": "172.20.20.30/16",
  "data_cidr": "10.2.0.0/16",
  "generation": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "cedar"
  }
}

スタック

安定性: 本番環境

スタックは、Heroku プラットフォームで使用できる別のアプリケーション実行環境です。

属性

名前	型	説明	例
created_at	日時	スタックが導入された日時	`"2012-01-01T12:00:00Z"`
default	ブール値	このスタックが新しいアプリのデフォルトであるかどうか	`true`
id	UUID	スタックの識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
name	文字列	一意の名前	`"heroku-18"`
state	文字列	このスタックの可用性: ベータ、非推奨、またはパブリック	`"public"`
updated_at	日時	スタックが最後に更新された日時	`"2012-01-01T12:00:00Z"`

スタックの情報

スタックの情報。

GET /stacks/{stack_name_or_id}

curl の例

$ curl -n https://api.heroku.com/stacks/$STACK_NAME_OR_ID \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "default": true,
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "name": "heroku-18",
  "state": "public",
  "updated_at": "2012-01-01T12:00:00Z"
}

スタックの一覧

使用可能なスタックを一覧表示します。

Range ヘッダーの容認可能な順序の値は id または name です。

GET /stacks

curl の例

$ curl -n https://api.heroku.com/stacks \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: id, name
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "default": true,
    "created_at": "2012-01-01T12:00:00Z",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "heroku-18",
    "state": "public",
    "updated_at": "2012-01-01T12:00:00Z"
  }
]

スタックの一覧

アプリで利用可能なアプリスタックを一覧表示します。

Range ヘッダーの容認可能な順序の値は id または name です。

GET /apps/{app_id_or_name}/available-stacks

curl の例

$ curl -n https://api.heroku.com/apps/$APP_ID_OR_NAME/available-stacks \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: id, name
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "default": true,
    "created_at": "2012-01-01T12:00:00Z",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "heroku-18",
    "state": "public",
    "updated_at": "2012-01-01T12:00:00Z"
  }
]

チーム

安定性: 開発

チームを使用すると、アプリケーションやその他のリソースの共有グループへのアクセスを管理できます。

属性

名前	型	説明	例
created_at	日時	チームが作成された日時	`"2012-01-01T12:00:00Z"`
credit_card_collections	ブール値	チームで発生した料金がクレジットカードで支払われるかどうか	`true`
default	ブール値	何も指定されていないときにこのチームを使用するかどうか	`true`
enterprise_account	null 許容オブジェクト		`null`
enterprise_account:id	UUID	エンタープライズアカウントの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
enterprise_account:name	文字列	エンタープライズアカウントの一意の名前	`"example"`
id	UUID	チームの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
identity_provider	null 許容オブジェクト	チームに関連付けられている ID プロバイダー	`null`
identity_provider:id	UUID	この ID プロバイダーの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
identity_provider:name	文字列	この ID プロバイダーのユーザーにわかりやすい一意識別子	`"acme-sso"`
identity_provider:owner:id	UUID	所有者の一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
identity_provider:owner:name	文字列	所有者の名前	`"acme"`
identity_provider:owner:type	文字列	所有者のタイプ次のうちのいずれか: `"team"`、`"enterprise-account"`	`"team"`
membership_limit	null 許容数値	チーム内で許可されるメンバーの上限	`25`
name	文字列	チームの一意の名前	`"example"`
provisioned_licenses	ブール値	このチームのライセンスが Salesforce によってプロビジョニングされるかどうか	`true`
role	null 許容文字列	チーム内のロール次のうちのいずれか: `"admin"`、`"collaborator"`、`"member"`、`"owner"`、`null`	`"admin"`
type	文字列	チームのタイプ。次のうちのいずれか: `"enterprise"`、`"team"`	`"team"`
updated_at	日時	チームが更新された日時	`"2012-01-01T12:00:00Z"`

チームの一覧

メンバーになっているチームを一覧表示します。

Range ヘッダーの容認可能な順序の値は id または name です。

GET /teams

curl の例

$ curl -n https://api.heroku.com/teams \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: id, name
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "created_at": "2012-01-01T12:00:00Z",
    "credit_card_collections": true,
    "default": true,
    "enterprise_account": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "example"
    },
    "identity_provider": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "acme-sso",
      "owner": {
        "id": "01234567-89ab-cdef-0123-456789abcdef",
        "name": "acme",
        "type": "team"
      }
    },
    "membership_limit": 25,
    "name": "example",
    "provisioned_licenses": true,
    "role": "admin",
    "type": "team",
    "updated_at": "2012-01-01T12:00:00Z"
  }
]

チームの情報

チームに関する情報。

GET /teams/{team_name_or_id}

curl の例

$ curl -n https://api.heroku.com/teams/$TEAM_NAME_OR_ID \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "created_at": "2012-01-01T12:00:00Z",
  "credit_card_collections": true,
  "default": true,
  "enterprise_account": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  },
  "identity_provider": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "acme-sso",
    "owner": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "acme",
      "type": "team"
    }
  },
  "membership_limit": 25,
  "name": "example",
  "provisioned_licenses": true,
  "role": "admin",
  "type": "team",
  "updated_at": "2012-01-01T12:00:00Z"
}

チームの更新

チームのプロパティを更新します。

PATCH /teams/{team_name_or_id}

オプションパラメータ

名前	型	説明	例
default	ブール値	何も指定されていないときにこのチームを使用するかどうか	`true`
name	文字列	チームの一意の名前	`"example"`

curl の例

$ curl -n -X PATCH https://api.heroku.com/teams/$TEAM_NAME_OR_ID \
  -d '{
  "default": true,
  "name": "example"
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "created_at": "2012-01-01T12:00:00Z",
  "credit_card_collections": true,
  "default": true,
  "enterprise_account": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  },
  "identity_provider": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "acme-sso",
    "owner": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "acme",
      "type": "team"
    }
  },
  "membership_limit": 25,
  "name": "example",
  "provisioned_licenses": true,
  "role": "admin",
  "type": "team",
  "updated_at": "2012-01-01T12:00:00Z"
}

チームの作成

新しいチームを作成します。

POST /teams

必須パラメータ

名前	型	説明	例
name	文字列	チームの一意の名前	`"example"`

オプションパラメータ

名前	型	説明	例
address_1	文字列	住所 1	`"40 Hickory Lane"`
address_2	null 許容文字列	住所 2	`"Suite 103"`
card_number	null 許容文字列	支払方法の暗号化されたカード番号	`"encrypted-card-number"`
city	文字列	市	`"San Francisco"`
country	文字列	国	`"US"`
cvv	null 許容文字列	カード確認値	`"123"`
device_data	null 許容文字列	クライアントによって生成されたデバイスデータ文字列	`"VGhpcyBpcyBhIGdvb2QgZGF5IHRvIGRpZQ=="`
expiration_month	null 許容文字列	有効期限の月	`"11"`
expiration_year	null 許容文字列	有効期限の年	`"2014"`
first_name	文字列	支払方法の名	`"Jason"`
last_name	文字列	支払方法の姓	`"Walker"`
nonce	null 許容文字列	Braintree でホストされているフィールドのフォームによって生成されたナンス	`"VGhpcyBpcyBhIGdvb2QgZGF5IHRvIGRpZQ=="`
other	null 許容文字列	メタデータ	`"Additional information for payment method"`
postal_code	文字列	郵便番号	`"90210"`
state	文字列	州	`"CA"`

curl の例

$ curl -n -X POST https://api.heroku.com/teams \
  -d '{
  "name": "example",
  "address_1": "40 Hickory Lane",
  "address_2": "Suite 103",
  "card_number": "encrypted-card-number",
  "city": "San Francisco",
  "country": "US",
  "cvv": "123",
  "expiration_month": "11",
  "expiration_year": "2014",
  "first_name": "Jason",
  "last_name": "Walker",
  "other": "Additional information for payment method",
  "postal_code": "90210",
  "state": "CA",
  "nonce": "VGhpcyBpcyBhIGdvb2QgZGF5IHRvIGRpZQ==",
  "device_data": "VGhpcyBpcyBhIGdvb2QgZGF5IHRvIGRpZQ=="
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 201 Created
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "created_at": "2012-01-01T12:00:00Z",
  "credit_card_collections": true,
  "default": true,
  "enterprise_account": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  },
  "identity_provider": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "acme-sso",
    "owner": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "acme",
      "type": "team"
    }
  },
  "membership_limit": 25,
  "name": "example",
  "provisioned_licenses": true,
  "role": "admin",
  "type": "team",
  "updated_at": "2012-01-01T12:00:00Z"
}

チームの削除

既存のチームを削除します。

DELETE /teams/{team_name_or_id}

curl の例

$ curl -n -X DELETE https://api.heroku.com/teams/$TEAM_NAME_OR_ID \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "created_at": "2012-01-01T12:00:00Z",
  "credit_card_collections": true,
  "default": true,
  "enterprise_account": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  },
  "identity_provider": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "acme-sso",
    "owner": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "acme",
      "type": "team"
    }
  },
  "membership_limit": 25,
  "name": "example",
  "provisioned_licenses": true,
  "role": "admin",
  "type": "team",
  "updated_at": "2012-01-01T12:00:00Z"
}

エンタープライズアカウントごとのチームの一覧

エンタープライズアカウントのチームを一覧表示します。

Range ヘッダーの容認可能な順序の値は id または name です。

GET /enterprise-accounts/{enterprise_account_id_or_name}/teams

curl の例

$ curl -n https://api.heroku.com/enterprise-accounts/$ENTERPRISE_ACCOUNT_ID_OR_NAME/teams \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: id, name
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "created_at": "2012-01-01T12:00:00Z",
    "credit_card_collections": true,
    "default": true,
    "enterprise_account": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "example"
    },
    "identity_provider": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "acme-sso",
      "owner": {
        "id": "01234567-89ab-cdef-0123-456789abcdef",
        "name": "acme",
        "type": "team"
      }
    },
    "membership_limit": 25,
    "name": "example",
    "provisioned_licenses": true,
    "role": "admin",
    "type": "team",
    "updated_at": "2012-01-01T12:00:00Z"
  }
]

エンタープライズアカウントのチームの作成

エンタープライズアカウントのチームを作成します。

POST /enterprise-accounts/{enterprise_account_id_or_name}/teams

必須パラメータ

名前	型	説明	例
name	文字列	チームの一意の名前	`"example"`

curl の例

$ curl -n -X POST https://api.heroku.com/enterprise-accounts/$ENTERPRISE_ACCOUNT_ID_OR_NAME/teams \
  -d '{
  "name": "example"
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 201 Created
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "created_at": "2012-01-01T12:00:00Z",
  "credit_card_collections": true,
  "default": true,
  "enterprise_account": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  },
  "identity_provider": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "acme-sso",
    "owner": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "acme",
      "type": "team"
    }
  },
  "membership_limit": 25,
  "name": "example",
  "provisioned_licenses": true,
  "role": "admin",
  "type": "team",
  "updated_at": "2012-01-01T12:00:00Z"
}

チームアドオン

安定性: 本番環境

チームのチームアドオンの一覧

すべてのチームアプリにわたって使用されるアドオンを一覧表示します。

GET /teams/{team_name_or_id}/addons

curl の例

$ curl -n https://api.heroku.com/teams/$TEAM_NAME_OR_ID/addons \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "actions": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "label": "Example",
      "action": "example",
      "url": "http://example.com?resource_id=:resource_id",
      "requires_owner": true
    },
    "addon_service": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "heroku-postgresql"
    },
    "billing_entity": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "example",
      "type": "app"
    },
    "app": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "example"
    },
    "billed_price": {
      "cents": 0,
      "contract": false,
      "unit": "month"
    },
    "config_vars": [
      "FOO",
      "BAZ"
    ],
    "created_at": "2012-01-01T12:00:00Z",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "acme-inc-primary-database",
    "plan": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "heroku-postgresql:dev"
    },
    "provider_id": "abcd1234",
    "provision_message": "example",
    "state": "provisioned",
    "updated_at": "2012-01-01T12:00:00Z",
    "web_url": "https://postgres.heroku.com/databases/01234567-89ab-cdef-0123-456789abcdef"
  }
]

チームアプリ

安定性: 開発

チームアプリは、Heroku アプリのチーム固有の機能をカプセル化します。

属性

名前	型	説明	例
archived_at	null 許容日時	アプリがアーカイブされた日時	`"2012-01-01T12:00:00Z"`
build_stack:id	UUID	スタックの識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
build_stack:name	文字列	一意の名前	`"heroku-18"`
buildpack_provided_description	null 許容文字列	アプリの buildpack からの説明	`"Ruby/Rack"`
created_at	日時	アプリが作成された日時	`"2012-01-01T12:00:00Z"`
git_url	文字列	アプリの Git リポジトリ URL パターン: `^https://git.heroku.com/[a-z][a-z0-9-]{2,29}.git$`	`"https://git.heroku.com/example.git"`
id	UUID	一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
internal_routing	null 許容ブール値	Private Spaces アプリが外部にルーティング可能かどうかの説明	`false`
joined	ブール値	現在のメンバーがこのアプリの共同作業者であるかどうか	`false`
locked	ブール値	このアプリへの参加を禁止されているその他のチームメンバーであるかどうか	`false`
maintenance	ブール値	アプリのメンテナンスステータス	`false`
name	文字列	アプリの名前パターン: `^[a-z][a-z0-9-]{1,28}[a-z0-9]$`	`"example"`
owner	null 許容オブジェクト	アプリの所有者の ID	`null`
owner:email	メール	一意のメールアドレス	`"username@example.com"`
owner:id	UUID	アカウントの識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
region:id	UUID	一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
region:name	文字列	リージョンの名前	`"us"`
released_at	null 許容日時	アプリがリリースされた日時	`"2012-01-01T12:00:00Z"`
repo_size	null 許容整数	アプリの Git リポジトリのサイズ (バイト単位)	`0`
slug_size	null 許容整数	アプリの slug のサイズ (バイト単位)	`0`
space	null 許容オブジェクト	Space の ID	`null`
space:id	UUID	Space の一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
space:name	文字列	Space の一意の名前パターン: `^[a-z0-9](?:[a-z0-9]\|-(?!-))+[a-z0-9]$`	`"nasa"`
stack:id	UUID	スタックの識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
stack:name	文字列	一意の名前	`"heroku-18"`
team	null 許容オブジェクト	このアプリを所有するチーム	`null`
team:name	文字列	チームの一意の名前	`"example"`
updated_at	日時	アプリが更新された日時	`"2012-01-01T12:00:00Z"`
web_url	null 許容 URI	アプリの Web URL パターン: `^https?://[a-z][a-z0-9-]{3,43}.herokuapp.com/$`	`"https://example.herokuapp.com/"`

チームアプリの作成

指定されたチーム、指定されていない場合はデフォルトチーム、またはデフォルトチームが設定されていない場合は個人のアカウントに新しいアプリを作成します。

POST /teams/apps

オプションパラメータ

名前	型	説明	例
internal_routing	null 許容ブール値	Private Spaces アプリが外部にルーティング可能かどうかの説明	`false`
locked	ブール値	このアプリへの参加を禁止されているその他のチームメンバーであるかどうか	`false`
name	文字列	アプリの名前パターン: `^[a-z][a-z0-9-]{1,28}[a-z0-9]$`	`"example"`
personal	ブール値	デフォルトチームが設定されている場合でもユーザーアカウントでアプリを強制的に作成します。	`false`
region	文字列	リージョンの名前	`"us"`
space	文字列	Space の一意の名前パターン: `^[a-z0-9](?:[a-z0-9]\|-(?!-))+[a-z0-9]$`	`"nasa"`
stack	文字列	一意の名前	`"heroku-18"`
team	文字列	チームの一意の名前	`"example"`

curl の例

$ curl -n -X POST https://api.heroku.com/teams/apps \
  -d '{
  "locked": false,
  "name": "example",
  "team": "example",
  "personal": false,
  "region": "us",
  "space": "nasa",
  "stack": "heroku-18",
  "internal_routing": false
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 201 Created
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "archived_at": "2012-01-01T12:00:00Z",
  "buildpack_provided_description": "Ruby/Rack",
  "build_stack": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "heroku-18"
  },
  "created_at": "2012-01-01T12:00:00Z",
  "git_url": "https://git.heroku.com/example.git",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "internal_routing": false,
  "joined": false,
  "locked": false,
  "maintenance": false,
  "name": "example",
  "team": {
    "name": "example"
  },
  "owner": {
    "email": "username@example.com",
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "region": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "us"
  },
  "released_at": "2012-01-01T12:00:00Z",
  "repo_size": 0,
  "slug_size": 0,
  "space": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "nasa"
  },
  "stack": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "heroku-18"
  },
  "updated_at": "2012-01-01T12:00:00Z",
  "web_url": "https://example.herokuapp.com/"
}

チームアプリの情報

チームアプリに関する情報。

GET /teams/apps/{team_app_name}

curl の例

$ curl -n https://api.heroku.com/teams/apps/$TEAM_APP_NAME \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "archived_at": "2012-01-01T12:00:00Z",
  "buildpack_provided_description": "Ruby/Rack",
  "build_stack": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "heroku-18"
  },
  "created_at": "2012-01-01T12:00:00Z",
  "git_url": "https://git.heroku.com/example.git",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "internal_routing": false,
  "joined": false,
  "locked": false,
  "maintenance": false,
  "name": "example",
  "team": {
    "name": "example"
  },
  "owner": {
    "email": "username@example.com",
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "region": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "us"
  },
  "released_at": "2012-01-01T12:00:00Z",
  "repo_size": 0,
  "slug_size": 0,
  "space": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "nasa"
  },
  "stack": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "heroku-18"
  },
  "updated_at": "2012-01-01T12:00:00Z",
  "web_url": "https://example.herokuapp.com/"
}

チームアプリの更新のロック

チームアプリをロックまたはロック解除します。

PATCH /teams/apps/{team_app_name}

必須パラメータ

名前	型	説明	例
locked	ブール値	このアプリへの参加を禁止されているその他のチームメンバーであるかどうか	`false`

curl の例

$ curl -n -X PATCH https://api.heroku.com/teams/apps/$TEAM_APP_NAME \
  -d '{
  "locked": false
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "archived_at": "2012-01-01T12:00:00Z",
  "buildpack_provided_description": "Ruby/Rack",
  "build_stack": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "heroku-18"
  },
  "created_at": "2012-01-01T12:00:00Z",
  "git_url": "https://git.heroku.com/example.git",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "internal_routing": false,
  "joined": false,
  "locked": false,
  "maintenance": false,
  "name": "example",
  "team": {
    "name": "example"
  },
  "owner": {
    "email": "username@example.com",
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "region": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "us"
  },
  "released_at": "2012-01-01T12:00:00Z",
  "repo_size": 0,
  "slug_size": 0,
  "space": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "nasa"
  },
  "stack": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "heroku-18"
  },
  "updated_at": "2012-01-01T12:00:00Z",
  "web_url": "https://example.herokuapp.com/"
}

チームアプリのアカウントへの移動

既存のチームアプリを別の Heroku アカウントに移動します。

PATCH /teams/apps/{team_app_name}

必須パラメータ

名前	型	説明	例
owner	文字列	一意のメールアドレス、アカウントの識別子、または現在承認されているユーザーへの暗黙的な参照	`"username@example.com"`、`"01234567-89ab-cdef-0123-456789abcdef"`、または `"~"`

curl の例

$ curl -n -X PATCH https://api.heroku.com/teams/apps/$TEAM_APP_NAME \
  -d '{
  "owner": "01234567-89ab-cdef-0123-456789abcdef"
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "archived_at": "2012-01-01T12:00:00Z",
  "buildpack_provided_description": "Ruby/Rack",
  "build_stack": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "heroku-18"
  },
  "created_at": "2012-01-01T12:00:00Z",
  "git_url": "https://git.heroku.com/example.git",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "internal_routing": false,
  "joined": false,
  "locked": false,
  "maintenance": false,
  "name": "example",
  "team": {
    "name": "example"
  },
  "owner": {
    "email": "username@example.com",
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "region": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "us"
  },
  "released_at": "2012-01-01T12:00:00Z",
  "repo_size": 0,
  "slug_size": 0,
  "space": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "nasa"
  },
  "stack": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "heroku-18"
  },
  "updated_at": "2012-01-01T12:00:00Z",
  "web_url": "https://example.herokuapp.com/"
}

チームアプリのチームへの移動

既存のチームアプリを別のチームに移動します。

PATCH /teams/apps/{team_app_name}

必須パラメータ

名前	型	説明	例
owner	文字列	チームの一意の名前	`"example"`

curl の例

$ curl -n -X PATCH https://api.heroku.com/teams/apps/$TEAM_APP_NAME \
  -d '{
  "owner": "example"
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "archived_at": "2012-01-01T12:00:00Z",
  "buildpack_provided_description": "Ruby/Rack",
  "build_stack": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "heroku-18"
  },
  "created_at": "2012-01-01T12:00:00Z",
  "git_url": "https://git.heroku.com/example.git",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "internal_routing": false,
  "joined": false,
  "locked": false,
  "maintenance": false,
  "name": "example",
  "team": {
    "name": "example"
  },
  "owner": {
    "email": "username@example.com",
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "region": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "us"
  },
  "released_at": "2012-01-01T12:00:00Z",
  "repo_size": 0,
  "slug_size": 0,
  "space": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "nasa"
  },
  "stack": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "heroku-18"
  },
  "updated_at": "2012-01-01T12:00:00Z",
  "web_url": "https://example.herokuapp.com/"
}

チームごとのチームアプリの一覧

チームアプリを一覧表示します。

Range ヘッダーの唯一の容認可能な順序の値は name です。

GET /teams/{team_name_or_id}/apps

curl の例

$ curl -n https://api.heroku.com/teams/$TEAM_NAME_OR_ID/apps \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: name
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "archived_at": "2012-01-01T12:00:00Z",
    "buildpack_provided_description": "Ruby/Rack",
    "build_stack": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "heroku-18"
    },
    "created_at": "2012-01-01T12:00:00Z",
    "git_url": "https://git.heroku.com/example.git",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "internal_routing": false,
    "joined": false,
    "locked": false,
    "maintenance": false,
    "name": "example",
    "team": {
      "name": "example"
    },
    "owner": {
      "email": "username@example.com",
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    },
    "region": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "us"
    },
    "released_at": "2012-01-01T12:00:00Z",
    "repo_size": 0,
    "slug_size": 0,
    "space": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "nasa"
    },
    "stack": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "heroku-18"
    },
    "updated_at": "2012-01-01T12:00:00Z",
    "web_url": "https://example.herokuapp.com/"
  }
]

チームアプリの共同作業者

安定性: 開発

チームの共同作業者は、Heroku 上のチームアプリへのアクセス権が与えられたアカウントを表します。

属性

名前	型	説明	例
app:id	UUID	一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
app:name	文字列	アプリの名前パターン: `^[a-z][a-z0-9-]{1,28}[a-z0-9]$`	`"example"`
created_at	日時	共同作業者が作成された日時	`"2012-01-01T12:00:00Z"`
id	UUID	共同作業者の一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
permissions	配列	共同作業者のアクセス許可の配列 (このアプリがチームのものである場合にのみ適用される)	`[{"name":"view","description":"Can manage config, deploy, run commands and restart the app."}]`
role	null 許容文字列	チーム内のロール次のうちのいずれか: `"admin"`、`"collaborator"`、`"member"`、`"owner"`、`null`	`"admin"`
updated_at	日時	共同作業者が更新された日時	`"2012-01-01T12:00:00Z"`
user:email	メール	一意のメールアドレス	`"username@example.com"`
user:federated	ブール値	ユーザーがフェデレーションされ、ID プロバイダーに属しているかどうか	`false`
user:id	UUID	アカウントの識別子	`"01234567-89ab-cdef-0123-456789abcdef"`

チームアプリの共同作業者の作成

チームアプリの新しい共同作業者を作成します。このエンドポイントは、共同作業者にチーム内の各自のロールに従ってアクセス許可を付与する場合に /apps/{app_id_or_name}/collaborator エンドポイントの代わりに使用します。

POST /teams/apps/{app_id_or_name}/collaborators

必須パラメータ

名前	型	説明	例
user	文字列	一意のメールアドレス、アカウントの識別子、または現在承認されているユーザーへの暗黙的な参照	`"username@example.com"`、`"01234567-89ab-cdef-0123-456789abcdef"`、または `"~"`

オプションパラメータ

名前	型	説明	例
permissions	配列	共同作業者に付与するアクセス許可の配列	`["view"]`
silent	ブール値	共同作業者を作成したときのメールの招待状を抑制するかどうか	`false`

curl の例

$ curl -n -X POST https://api.heroku.com/teams/apps/$APP_ID_OR_NAME/collaborators \
  -d '{
  "permissions": [
    "view"
  ],
  "silent": false,
  "user": "01234567-89ab-cdef-0123-456789abcdef"
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 201 Created
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "app": {
    "name": "example",
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "permissions": [
    {
      "name": "view",
      "description": "Can manage config, deploy, run commands and restart the app."
    }
  ],
  "role": "admin",
  "updated_at": "2012-01-01T12:00:00Z",
  "user": {
    "email": "username@example.com",
    "federated": false,
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  }
}

チームアプリの共同作業者の削除

チームアプリの既存の共同作業者を削除します。

DELETE /teams/apps/{team_app_name}/collaborators/{team_app_collaborator_email}

curl の例

$ curl -n -X DELETE https://api.heroku.com/teams/apps/$TEAM_APP_NAME/collaborators/$TEAM_APP_COLLABORATOR_EMAIL \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "app": {
    "name": "example",
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "permissions": [
    {
      "name": "view",
      "description": "Can manage config, deploy, run commands and restart the app."
    }
  ],
  "role": "admin",
  "updated_at": "2012-01-01T12:00:00Z",
  "user": {
    "email": "username@example.com",
    "federated": false,
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  }
}

チームアプリの共同作業者の情報

チームアプリの共同作業者に関する情報。

GET /teams/apps/{team_app_name}/collaborators/{team_app_collaborator_email}

curl の例

$ curl -n https://api.heroku.com/teams/apps/$TEAM_APP_NAME/collaborators/$TEAM_APP_COLLABORATOR_EMAIL \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "app": {
    "name": "example",
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "permissions": [
    {
      "name": "view",
      "description": "Can manage config, deploy, run commands and restart the app."
    }
  ],
  "role": "admin",
  "updated_at": "2012-01-01T12:00:00Z",
  "user": {
    "email": "username@example.com",
    "federated": false,
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  }
}

チームアプリの共同作業者の更新

チームアプリの既存の共同作業者を更新します。

PATCH /teams/apps/{team_app_name}/collaborators/{team_app_collaborator_email}

必須パラメータ

名前	型	説明	例
permissions	配列	共同作業者に付与するアクセス許可の配列	`["view"]`

curl の例

$ curl -n -X PATCH https://api.heroku.com/teams/apps/$TEAM_APP_NAME/collaborators/$TEAM_APP_COLLABORATOR_EMAIL \
  -d '{
  "permissions": [
    "view"
  ]
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "app": {
    "name": "example",
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "permissions": [
    {
      "name": "view",
      "description": "Can manage config, deploy, run commands and restart the app."
    }
  ],
  "role": "admin",
  "updated_at": "2012-01-01T12:00:00Z",
  "user": {
    "email": "username@example.com",
    "federated": false,
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  }
}

チームアプリの共同作業者の一覧

チームアプリの共同作業者を一覧表示します。

Range ヘッダーの唯一の容認可能な順序の値は email です。

GET /teams/apps/{team_app_name}/collaborators

curl の例

$ curl -n https://api.heroku.com/teams/apps/$TEAM_APP_NAME/collaborators \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: email
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "app": {
      "name": "example",
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    },
    "created_at": "2012-01-01T12:00:00Z",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "permissions": [
      {
        "name": "view",
        "description": "Can manage config, deploy, run commands and restart the app."
      }
    ],
    "role": "admin",
    "updated_at": "2012-01-01T12:00:00Z",
    "user": {
      "email": "username@example.com",
      "federated": false,
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    }
  }
]

チームアプリアクセス許可

安定性: プロトタイプ

チームアプリアクセス許可は、チームアプリのユーザーに割り当てられる動作です。

属性

名前	型	説明	例
description	文字列	アプリアクセス許可で許可される内容の説明	`"Can manage config, deploy, run commands and restart the app."`
name	文字列	アプリアクセス許可の名前	`"view"`

チームアプリアクセス許可の一覧

チームで使用できるアクセス許可を一覧表示します。

Range ヘッダーの唯一の容認可能な順序の値は name です。

GET /teams/permissions

curl の例

$ curl -n https://api.heroku.com/teams/permissions \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: name
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "name": "view",
    "description": "Can manage config, deploy, run commands and restart the app."
  }
]

チームの毎日の使用状況

安定性: 開発

毎日の解像度でのエンタープライズチームの使用状況。

属性

名前	型	説明	例
addons	数値	使用されている合計アドオンクレジット	`250.0`
apps	配列	チームでのアプリの使用状況	`[{"addons":250.0,"app_name":"example","data":34.89,"dynos":1.548,"partner":12.34}]`
data	数値	ファーストパーティのアドオンに使用されている合計アドオンクレジット	`34.89`
date	日付	使用状況の日付	`"2019-01-01"`
dynos	数値	使用されている dyno の数	`1.548`
id	UUID	チームの識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
name	文字列	チームの名前	`"ops"`
partner	数値	サードパーティのアドオンに使用されている合計アドオンクレジット	`12.34`
space	数値	使用されている Space クレジット	`1.548`

チームの毎日の使用状況の情報

日数の範囲でのエンタープライズチームの使用状況を取得します。開始日と終了日は、YYYY-MM-DD の日付形式を使用してクエリパラメータとして指定できます。チームの識別子については、チームの一覧エンドポイントを参照してください。

GET /teams/{team_id}/usage/daily

必須パラメータ

名前	型	説明	例
start	文字列	範囲の開始日パターン: `^[0-9]{4}-[0-9]{2}-[0-9]{2}$`	`"2019-01-25"`

オプションパラメータ

名前	型	説明	例
end	文字列	範囲の終了日パターン: `^[0-9]{4}-[0-9]{2}-[0-9]{2}$`	`"2019-02-25"`

curl の例

$ curl -n https://api.heroku.com/teams/$TEAM_ID/usage/daily \
 -G \
  -d start=2019-01-25 \
  -d end=2019-02-25 \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "addons": 250.0,
    "apps": [
      {
        "addons": 250.0,
        "app_name": "example",
        "data": 34.89,
        "dynos": 1.548,
        "partner": 12.34
      }
    ],
    "data": 34.89,
    "date": "2019-01-01",
    "dynos": 1.548,
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "ops",
    "partner": 12.34,
    "space": 1.548
  }
]

チームの義務不履行

安定性: 開発

Heroku チームは支払いの確認がとれていないため義務不履行となります。請求書が未払いのままの場合は、義務不履行チームを中断し、削除します。

属性

名前	型	説明	例
scheduled_deletion_time	null 許容日時	義務不履行によりチームを削除するスケジュール済み時刻	`"2024-01-01T12:00:00Z"`
scheduled_suspension_time	null 許容日時	義務不履行によりチームを中断するスケジュール済み時刻	`"2024-01-01T12:00:00Z"`

チームの義務不履行情報

チームの義務不履行情報。

GET /teams/{team_name_or_id}/delinquency

curl の例

$ curl -n https://api.heroku.com/teams/$TEAM_NAME_OR_ID/delinquency \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "scheduled_suspension_time": "2024-01-01T12:00:00Z",
  "scheduled_deletion_time": "2024-01-01T12:00:00Z"
}

チーム機能

安定性: 開発

チーム機能は、チームアカウントで有効になっている機能を表します。

属性

名前	型	説明	例
created_at	日時	チーム機能が作成された日時	`"2012-01-01T12:00:00Z"`
description	文字列	チーム機能の説明	`"Causes account to example."`
display_name	文字列	ユーザーで解読可能な機能名	`"My Feature"`
doc_url	文字列	チーム機能のドキュメント URL	`"http://devcenter.heroku.com/articles/example"`
enabled	ブール値	チーム機能が有効になっているかどうか	`true`
feedback_email	文字列	機能に関するフィードバックを送信するためのメール	`"feedback@heroku.com"`
id	UUID	チーム機能の一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
name	文字列	チーム機能の一意の名前	`"name"`
state	文字列	チーム機能の状態	`"public"`
updated_at	日時	チーム機能が更新された日時	`"2012-01-01T12:00:00Z"`

チーム機能の情報

既存のチーム機能に関する情報。

GET /teams/{team_name_or_id}/features/{team_feature_id_or_name}

curl の例

$ curl -n https://api.heroku.com/teams/$TEAM_NAME_OR_ID/features/$TEAM_FEATURE_ID_OR_NAME \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "created_at": "2012-01-01T12:00:00Z",
  "description": "Causes account to example.",
  "doc_url": "http://devcenter.heroku.com/articles/example",
  "enabled": true,
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "name": "name",
  "state": "public",
  "updated_at": "2012-01-01T12:00:00Z",
  "display_name": "My Feature",
  "feedback_email": "feedback@heroku.com"
}

チーム機能の一覧

既存のチーム機能を一覧表示します。

Range ヘッダーの容認可能な順序の値は id または name です。

GET /teams/{team_name_or_id}/features

curl の例

$ curl -n https://api.heroku.com/teams/$TEAM_NAME_OR_ID/features \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: id, name
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "created_at": "2012-01-01T12:00:00Z",
    "description": "Causes account to example.",
    "doc_url": "http://devcenter.heroku.com/articles/example",
    "enabled": true,
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "name",
    "state": "public",
    "updated_at": "2012-01-01T12:00:00Z",
    "display_name": "My Feature",
    "feedback_email": "feedback@heroku.com"
  }
]

チーム招待

安定性: 開発

チーム招待は、チームへの招待を表します。

属性

名前	型	説明	例
created_at	日時	招待が作成された日時	`"2012-01-01T12:00:00Z"`
id	UUID	招待の一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
invited_by:email	メール	一意のメールアドレス	`"username@example.com"`
invited_by:id	UUID	アカウントの識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
invited_by:name	null 許容文字列	アカウント所有者のフルネーム	`"Tina Edmonds"`
role	null 許容文字列	チーム内のロール次のうちのいずれか: `"admin"`、`"collaborator"`、`"member"`、`"owner"`、`null`	`"admin"`
team:id	UUID	チームの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
team:name	文字列	チームの一意の名前	`"example"`
updated_at	日時	招待が更新された日時	`"2012-01-01T12:00:00Z"`
user:email	メール	一意のメールアドレス	`"username@example.com"`
user:id	UUID	アカウントの識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
user:name	null 許容文字列	アカウント所有者のフルネーム	`"Tina Edmonds"`

チーム招待の一覧

チームの ID プロバイダーの一覧を取得します。

Range ヘッダーの唯一の容認可能な順序の値は id です。

GET /teams/{team_name}/invitations

curl の例

$ curl -n https://api.heroku.com/teams/$TEAM_NAME/invitations \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: id
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "created_at": "2012-01-01T12:00:00Z",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "invited_by": {
      "email": "username@example.com",
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "Tina Edmonds"
    },
    "team": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "example"
    },
    "role": "admin",
    "updated_at": "2012-01-01T12:00:00Z",
    "user": {
      "email": "username@example.com",
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "Tina Edmonds"
    }
  }
]

チーム招待の作成

チーム招待を作成します。

PUT /teams/{team_name_or_id}/invitations

必須パラメータ

名前	型	説明	例
email	メール	一意のメールアドレス	`"username@example.com"`
role	null 許容文字列	チーム内のロール次のうちのいずれか: `"admin"`、`"collaborator"`、`"member"`、`"owner"`、`null`	`"admin"`

curl の例

$ curl -n -X PUT https://api.heroku.com/teams/$TEAM_NAME_OR_ID/invitations \
  -d '{
  "email": "username@example.com",
  "role": "admin"
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "invited_by": {
    "email": "username@example.com",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "Tina Edmonds"
  },
  "team": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  },
  "role": "admin",
  "updated_at": "2012-01-01T12:00:00Z",
  "user": {
    "email": "username@example.com",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "Tina Edmonds"
  }
}

チーム招待の取り消し

チーム招待を取り消します。

DELETE /teams/{team_name_or_id}/invitations/{team_invitation_id}

curl の例

$ curl -n -X DELETE https://api.heroku.com/teams/$TEAM_NAME_OR_ID/invitations/$TEAM_INVITATION_ID \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "invited_by": {
    "email": "username@example.com",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "Tina Edmonds"
  },
  "team": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  },
  "role": "admin",
  "updated_at": "2012-01-01T12:00:00Z",
  "user": {
    "email": "username@example.com",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "Tina Edmonds"
  }
}

チーム招待の取得

招待をそのトークンで取得します。

Range ヘッダーの唯一の容認可能な順序の値は id です。

GET /teams/invitations/{team_invitation_token}

curl の例

$ curl -n https://api.heroku.com/teams/invitations/$TEAM_INVITATION_TOKEN \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: id
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "invited_by": {
    "email": "username@example.com",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "Tina Edmonds"
  },
  "team": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "example"
  },
  "role": "admin",
  "updated_at": "2012-01-01T12:00:00Z",
  "user": {
    "email": "username@example.com",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "Tina Edmonds"
  }
}

チーム招待の受け入れ

チーム招待を受け入れます。

POST /teams/invitations/{team_invitation_token}/accept

curl の例

$ curl -n -X POST https://api.heroku.com/teams/invitations/$TEAM_INVITATION_TOKEN/accept \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 201 Created
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "created_at": "2012-01-01T12:00:00Z",
  "email": "someone@example.org",
  "federated": false,
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "identity_provider": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "acme",
    "redacted": false,
    "owner": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "acme",
      "type": "team"
    }
  },
  "role": "admin",
  "two_factor_authentication": true,
  "updated_at": "2012-01-01T12:00:00Z",
  "user": {
    "email": "username@example.com",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "Tina Edmonds"
  }
}

チーム請求書

安定性: 開発

チーム請求書は、価格設定と料金が含まれている、チームに対する商品の請求明細書です。

属性

名前	型	説明	例
addons_total	整数	この請求書での合計アドオン料金	`25000`
charges_total	整数	この請求書での合計料金	`0`
created_at	日時	請求書が作成された日時	`"2012-01-01T12:00:00Z"`
credits_total	整数	この請求書での合計クレジット	`100000`
database_total	整数	この請求書での合計データベース料金	`25000`
dyno_units	数値	複数の dyno タイプにわたって消費された dyno ユニットの合計量	`1.92`
id	UUID	この請求書の一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
number	整数	人間に解読可能な請求書番号	`9403943`
payment_status	文字列	請求書の支払ステータス	`"Paid"`
period_end	文字列	この請求書に含まれている終了日	`"01/31/2014"`
period_start	文字列	この請求書に含まれている開始日	`"01/01/2014"`
platform_total	整数	この請求書での合計プラットフォーム料金	`50000`
state	整数	この請求書の支払ステータス (保留中、成功、失敗)	`1`
total	整数	この請求書での料金とクレジットの組み合わせ合計	`100000`
updated_at	日時	請求書が更新された日時	`"2012-01-01T12:00:00Z"`
weighted_dyno_hours	数値	複数の dyno タイプにわたって消費された時間の合計量	`1488`

チーム請求書の情報

既存の請求書に関する情報。

GET /teams/{team_name_or_id}/invoices/{team_invoice_number}

curl の例

$ curl -n https://api.heroku.com/teams/$TEAM_NAME_OR_ID/invoices/$TEAM_INVOICE_NUMBER \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "addons_total": 25000,
  "database_total": 25000,
  "charges_total": 0,
  "created_at": "2012-01-01T12:00:00Z",
  "credits_total": 100000,
  "dyno_units": 1.92,
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "number": 9403943,
  "payment_status": "Paid",
  "period_end": "01/31/2014",
  "period_start": "01/01/2014",
  "platform_total": 50000,
  "state": 1,
  "total": 100000,
  "updated_at": "2012-01-01T12:00:00Z",
  "weighted_dyno_hours": 1488
}

チーム請求書の一覧

既存の請求書を一覧表示します。

Range ヘッダーの唯一の容認可能な順序の値は number です。

GET /teams/{team_name_or_id}/invoices

curl の例

$ curl -n https://api.heroku.com/teams/$TEAM_NAME_OR_ID/invoices \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: number
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "addons_total": 25000,
    "database_total": 25000,
    "charges_total": 0,
    "created_at": "2012-01-01T12:00:00Z",
    "credits_total": 100000,
    "dyno_units": 1.92,
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "number": 9403943,
    "payment_status": "Paid",
    "period_end": "01/31/2014",
    "period_start": "01/01/2014",
    "platform_total": 50000,
    "state": 1,
    "total": 100000,
    "updated_at": "2012-01-01T12:00:00Z",
    "weighted_dyno_hours": 1488
  }
]

チームメンバー

安定性: 開発

チームメンバーは、チームにアクセスできる個人です。

属性

名前	型	説明	例
created_at	日時	メンバーシップレコードが作成された日時	`"2012-01-01T12:00:00Z"`
メール	文字列	チームメンバーのメールアドレス	`"someone@example.org"`
federated	ブール値	ユーザーがフェデレーションされ、ID プロバイダーに属しているかどうか	`false`
id	UUID	チームメンバーの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
identity_provider	null 許容オブジェクト	メンバーがフェデレーションされている ID プロバイダーの情報	`null`
identity_provider:id	UUID	この ID プロバイダーの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
identity_provider:name	文字列	ID プロバイダーの名前	`"acme"`
identity_provider:owner:id	UUID	所有者の一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
identity_provider:owner:name	文字列	所有者の名前	`"acme"`
identity_provider:owner:type	文字列	所有者のタイプ次のうちのいずれか: `"team"`、`"enterprise-account"`	`"team"`
identity_provider:redacted	ブール値	identity_provider 情報が編集されているかどうか	`false`
role	null 許容文字列	チーム内のロール次のうちのいずれか: `"admin"`、`"collaborator"`、`"member"`、`"owner"`、`null`	`"admin"`
two_factor_authentication	ブール値	チームメンバーの 2 要素認証が有効になっているかどうか	`true`
updated_at	日時	メンバーシップレコードが更新された日時	`"2012-01-01T12:00:00Z"`
user:email	メール	一意のメールアドレス	`"username@example.com"`
user:id	UUID	アカウントの識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
user:name	null 許容文字列	アカウント所有者のフルネーム	`"Tina Edmonds"`

チームメンバーの作成または更新

新しいチームメンバーを作成するか、またはチームメンバーのロールを更新します。

PUT /teams/{team_name_or_id}/members

必須パラメータ

名前	型	説明	例
email	文字列	チームメンバーのメールアドレス	`"someone@example.org"`
role	文字列	チーム内のロール次のうちのいずれか: `"admin"`、`"viewer"`、`"member"`	`"admin"`

オプションパラメータ

名前	型	説明	例
federated	ブール値	ユーザーがフェデレーションされ、ID プロバイダーに属しているかどうか	`false`

curl の例

$ curl -n -X PUT https://api.heroku.com/teams/$TEAM_NAME_OR_ID/members \
  -d '{
  "email": "someone@example.org",
  "federated": false,
  "role": "admin"
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 201 Created
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "created_at": "2012-01-01T12:00:00Z",
  "email": "someone@example.org",
  "federated": false,
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "identity_provider": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "acme",
    "redacted": false,
    "owner": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "acme",
      "type": "team"
    }
  },
  "role": "admin",
  "two_factor_authentication": true,
  "updated_at": "2012-01-01T12:00:00Z",
  "user": {
    "email": "username@example.com",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "Tina Edmonds"
  }
}

チームメンバーの作成

新しいチームメンバーを作成します。

POST /teams/{team_name_or_id}/members

必須パラメータ

名前	型	説明	例
email	文字列	チームメンバーのメールアドレス	`"someone@example.org"`
role	文字列	チーム内のロール次のうちのいずれか: `"admin"`、`"viewer"`、`"member"`	`"admin"`

オプションパラメータ

名前	型	説明	例
federated	ブール値	ユーザーがフェデレーションされ、ID プロバイダーに属しているかどうか	`false`

curl の例

$ curl -n -X POST https://api.heroku.com/teams/$TEAM_NAME_OR_ID/members \
  -d '{
  "email": "someone@example.org",
  "federated": false,
  "role": "admin"
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 201 Created
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "created_at": "2012-01-01T12:00:00Z",
  "email": "someone@example.org",
  "federated": false,
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "identity_provider": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "acme",
    "redacted": false,
    "owner": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "acme",
      "type": "team"
    }
  },
  "role": "admin",
  "two_factor_authentication": true,
  "updated_at": "2012-01-01T12:00:00Z",
  "user": {
    "email": "username@example.com",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "Tina Edmonds"
  }
}

チームメンバーの更新

チームメンバーを更新します。

PATCH /teams/{team_name_or_id}/members

必須パラメータ

名前	型	説明	例
email	文字列	チームメンバーのメールアドレス	`"someone@example.org"`
role	文字列	チーム内のロール次のうちのいずれか: `"admin"`、`"viewer"`、`"member"`	`"admin"`

オプションパラメータ

名前	型	説明	例
federated	ブール値	ユーザーがフェデレーションされ、ID プロバイダーに属しているかどうか	`false`

curl の例

$ curl -n -X PATCH https://api.heroku.com/teams/$TEAM_NAME_OR_ID/members \
  -d '{
  "email": "someone@example.org",
  "federated": false,
  "role": "admin"
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "created_at": "2012-01-01T12:00:00Z",
  "email": "someone@example.org",
  "federated": false,
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "identity_provider": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "acme",
    "redacted": false,
    "owner": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "acme",
      "type": "team"
    }
  },
  "role": "admin",
  "two_factor_authentication": true,
  "updated_at": "2012-01-01T12:00:00Z",
  "user": {
    "email": "username@example.com",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "Tina Edmonds"
  }
}

チームメンバーの削除

チームからメンバーを削除します。

DELETE /teams/{team_name_or_id}/members/{team_member_email_or_id}

curl の例

$ curl -n -X DELETE https://api.heroku.com/teams/$TEAM_NAME_OR_ID/members/$TEAM_MEMBER_EMAIL_OR_ID \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "created_at": "2012-01-01T12:00:00Z",
  "email": "someone@example.org",
  "federated": false,
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "identity_provider": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "acme",
    "redacted": false,
    "owner": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "acme",
      "type": "team"
    }
  },
  "role": "admin",
  "two_factor_authentication": true,
  "updated_at": "2012-01-01T12:00:00Z",
  "user": {
    "email": "username@example.com",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "Tina Edmonds"
  }
}

チームメンバーの一覧

チームのメンバーを一覧表示します。

Range ヘッダーの唯一の容認可能な順序の値は email です。

GET /teams/{team_name_or_id}/members

curl の例

$ curl -n https://api.heroku.com/teams/$TEAM_NAME_OR_ID/members \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: email
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "created_at": "2012-01-01T12:00:00Z",
    "email": "someone@example.org",
    "federated": false,
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "identity_provider": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "acme",
      "redacted": false,
      "owner": {
        "id": "01234567-89ab-cdef-0123-456789abcdef",
        "name": "acme",
        "type": "team"
      }
    },
    "role": "admin",
    "two_factor_authentication": true,
    "updated_at": "2012-01-01T12:00:00Z",
    "user": {
      "email": "username@example.com",
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "Tina Edmonds"
    }
  }
]

メンバーごとのチームメンバーの一覧

チームメンバーのアプリを一覧表示します。

Range ヘッダーの容認可能な順序の値は email または id です。

GET /teams/{team_name_or_id}/members/{team_member_email_or_id}/apps

curl の例

$ curl -n https://api.heroku.com/teams/$TEAM_NAME_OR_ID/members/$TEAM_MEMBER_EMAIL_OR_ID/apps \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: email, id
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "archived_at": "2012-01-01T12:00:00Z",
    "buildpack_provided_description": "Ruby/Rack",
    "build_stack": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "heroku-18"
    },
    "created_at": "2012-01-01T12:00:00Z",
    "git_url": "https://git.heroku.com/example.git",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "internal_routing": false,
    "joined": false,
    "locked": false,
    "maintenance": false,
    "name": "example",
    "team": {
      "name": "example"
    },
    "owner": {
      "email": "username@example.com",
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    },
    "region": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "us"
    },
    "released_at": "2012-01-01T12:00:00Z",
    "repo_size": 0,
    "slug_size": 0,
    "space": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "nasa"
    },
    "stack": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "heroku-18"
    },
    "updated_at": "2012-01-01T12:00:00Z",
    "web_url": "https://example.herokuapp.com/"
  }
]

チームの毎月の使用状況

安定性: 開発

毎月の解像度でのエンタープライズチームの使用状況。

属性

名前	型	説明	例
addons	数値	使用されている合計アドオンクレジット	`250.0`
apps	配列	チームでのアプリの使用状況	`[{"addons":250.0,"app_name":"example","data":34.89,"dynos":1.548,"partner":12.34}]`
connect	数値	同期された Connect 行の最大数	`15000`
data	数値	ファーストパーティのアドオンに使用されている合計アドオンクレジット	`34.89`
dynos	数値	使用されている dyno の数	`1.548`
id	UUID	チームの識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
month	文字列	使用状況の年と月パターン: `^[0-9]{4}-[0-9]{2}$`	`"2019-01"`
name	文字列	チームの名前	`"ops"`
partner	数値	サードパーティのアドオンに使用されている合計アドオンクレジット	`12.34`
space	数値	使用されている Space クレジット	`1.548`

チームの毎月の使用状況の情報

月数の範囲でのエンタープライズチームの使用状況を取得します。開始日と終了日は、YYYY-MM の日付形式を使用してクエリパラメータとして指定できます。終了日が指定されない場合は、1 か月の使用状況が返されます。チームの識別子については、チームの一覧エンドポイントを参照してください。

GET /teams/{team_id}/usage/monthly

必須パラメータ

名前	型	説明	例
start	文字列	範囲の開始日パターン: `^[0-9]{4}-[0-9]{2}$`	`"2019-01"`

オプションパラメータ

名前	型	説明	例
end	文字列	範囲の終了日パターン: `^[0-9]{4}-[0-9]{2}$`	`"2019-02"`

curl の例

$ curl -n https://api.heroku.com/teams/$TEAM_ID/usage/monthly \
 -G \
  -d start=2019-01 \
  -d end=2019-02 \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "addons": 250.0,
    "apps": [
      {
        "addons": 250.0,
        "app_name": "example",
        "data": 34.89,
        "dynos": 1.548,
        "partner": 12.34
      }
    ],
    "connect": 15000,
    "data": 34.89,
    "dynos": 1.548,
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "month": "2019-01",
    "name": "ops",
    "partner": 12.34,
    "space": 1.548
  }
]

チーム設定

安定性: 開発

チームの設定を追跡します。

属性

名前	型	説明	例
addons-controls	null 許容ブール値	アドオンのインストールにアドオンサービスルールを適用すべきかどうか	`true`
default-permission	null 許容文字列	チームに新しいメンバーを追加するときに使用されるデフォルトのアクセス許可次のうちのいずれか: `"admin"`、`"member"`、`"viewer"`、`null`	`"member"`

チーム設定の一覧

チーム設定を取得します。

GET /teams/{team_preferences_name_or_id}/preferences

curl の例

$ curl -n https://api.heroku.com/teams/$TEAM_PREFERENCES_NAME_OR_ID/preferences \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "default-permission": "member",
  "addons-controls": true
}

チーム設定の更新

チーム設定を更新します。

PATCH /teams/{team_preferences_name_or_id}/preferences

オプションパラメータ

名前	型	説明	例
addons-controls	null 許容ブール値	アドオンのインストールにアドオンサービスルールを適用すべきかどうか	`true`

curl の例

$ curl -n -X PATCH https://api.heroku.com/teams/$TEAM_PREFERENCES_NAME_OR_ID/preferences \
  -d '{
  "addons-controls": true
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "default-permission": "member",
  "addons-controls": true
}

チーム Space

安定性: プロトタイプ

Space は、分離された、可用性の高い、安全なアプリ実行環境です。

チーム Space の一覧

チームによって所有されている Space を一覧表示します。

GET /teams/{team_name_or_id}/spaces

curl の例

$ curl -n https://api.heroku.com/teams/$TEAM_NAME_OR_ID/spaces \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "created_at": "2012-01-01T12:00:00Z",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "nasa",
    "organization": {
      "name": "example"
    },
    "team": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "example"
    },
    "region": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "us"
    },
    "shield": true,
    "state": "allocated",
    "updated_at": "2012-01-01T12:00:00Z",
    "cidr": "172.20.20.30/16",
    "data_cidr": "10.2.0.0/16",
    "generation": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "cedar"
    }
  }
]

テレメトリードレイン

安定性: プロトタイプ

テレメトリードレインは、OpenTelemetry のトレース、メトリクス、ログを自分のコンシューマーに転送します。これは Fir 世代のアプリ専用です。

属性

名前	型	説明	例
created_at	日時	テレメトリードレインが作成された日時	`"2024-12-01T12:00:00Z"`
exporter:endpoint	文字列	OpenTelemetry コンシューマーの URI 長さ: `0..1000`	`"https://api.otelproduct.example/consumer"`
exporter:headers	オブジェクト	OpenTelemetry コンシューマーに送信する JSON ヘッダーデフォルト値: `{}`	`{"API-Key":"example_api_key_012345","Environment":"production"}`
exporter:type	文字列	OpenTelemetry コンシューマーに使用するトランスポートタイプ次のうちのいずれか: `"otlphttp"`、`"otlp"`	`"otlphttp"`
id	UUID	テレメトリードレインの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
owner:id	UUID	所有者の一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
owner:type	文字列	所有者のタイプ次のうちのいずれか: `"app"`、`"space"`	`"app"`
signals	配列	テレメトリードレインに送信する OpenTelemetry シグナル	`["traces","metrics"]`
updated_at	日時	テレメトリードレインが最後に更新された日時	`"2012-01-01T12:00:00Z"`

テレメトリードレインの作成

テレメトリードレインを作成します。

POST /telemetry-drains

必須パラメータ

名前	型	説明	例
exporter:endpoint	文字列	OpenTelemetry コンシューマーの URI 長さ: `0..1000`	`"https://api.otelproduct.example/consumer"`
exporter:headers	オブジェクト	OpenTelemetry コンシューマーに送信する JSON ヘッダーデフォルト値: `{}`	`{"API-Key":"example_api_key_012345","Environment":"production"}`
exporter:type	文字列	OpenTelemetry コンシューマーに使用するトランスポートタイプ次のうちのいずれか: `"otlphttp"`、`"otlp"`	`"otlphttp"`
owner:id	UUID	所有者の一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
owner:type	文字列	所有者のタイプ次のうちのいずれか: `"app"`、`"space"`	`"app"`
signals	配列	テレメトリードレインに送信する OpenTelemetry シグナル	`["traces","metrics"]`

curl の例

$ curl -n -X POST https://api.heroku.com/telemetry-drains \
  -d '{
  "owner": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "type": "app"
  },
  "signals": [
    "traces",
    "metrics"
  ],
  "exporter": {
    "type": "otlphttp",
    "endpoint": "https://api.otelproduct.example/consumer",
    "headers": {
      "API-Key": "example_api_key_012345",
      "Environment": "production"
    }
  }
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 201 Created
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "created_at": "2024-12-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "owner": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "type": "app"
  },
  "signals": [
    "traces",
    "metrics"
  ],
  "exporter": {
    "type": "otlphttp",
    "endpoint": "https://api.otelproduct.example/consumer",
    "headers": {
      "API-Key": "example_api_key_012345",
      "Environment": "production"
    }
  },
  "updated_at": "2012-01-01T12:00:00Z"
}

アプリごとのテレメトリードレインの一覧

アプリのテレメトリードレインを一覧表示します。

Range ヘッダーの唯一の容認可能な順序の値は id です。

GET /apps/{app_id_or_name}/telemetry-drains

curl の例

$ curl -n https://api.heroku.com/apps/$APP_ID_OR_NAME/telemetry-drains \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: id
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "created_at": "2024-12-01T12:00:00Z",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "owner": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "type": "app"
    },
    "signals": [
      "traces",
      "metrics"
    ],
    "exporter": {
      "type": "otlphttp",
      "endpoint": "https://api.otelproduct.example/consumer",
      "headers": {
        "API-Key": "example_api_key_012345",
        "Environment": "production"
      }
    },
    "updated_at": "2012-01-01T12:00:00Z"
  }
]

スペースごとのテレメトリードレインの一覧

スペースのテレメトリードレインを一覧表示します。

Range ヘッダーの唯一の容認可能な順序の値は id です。

GET /spaces/{space_id_or_name}/telemetry-drains

curl の例

$ curl -n https://api.heroku.com/spaces/$SPACE_ID_OR_NAME/telemetry-drains \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: id
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "created_at": "2024-12-01T12:00:00Z",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "owner": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "type": "app"
    },
    "signals": [
      "traces",
      "metrics"
    ],
    "exporter": {
      "type": "otlphttp",
      "endpoint": "https://api.otelproduct.example/consumer",
      "headers": {
        "API-Key": "example_api_key_012345",
        "Environment": "production"
      }
    },
    "updated_at": "2012-01-01T12:00:00Z"
  }
]

テレメトリードレインの更新

テレメトリードレインを更新します。

PATCH /telemetry-drains/{telemetry_drain_id}

オプションパラメータ

名前	型	説明	例
exporter:endpoint	文字列	OpenTelemetry コンシューマーの URI 長さ: `0..1000`	`"https://api.otelproduct.example/consumer"`
exporter:headers	オブジェクト	OpenTelemetry コンシューマーに送信する JSON ヘッダーデフォルト値: `{}`	`{"API-Key":"example_api_key_012345","Environment":"production"}`
exporter:type	文字列	OpenTelemetry コンシューマーに使用するトランスポートタイプ次のうちのいずれか: `"otlphttp"`、`"otlp"`	`"otlphttp"`
signals	配列	テレメトリードレインに送信する OpenTelemetry シグナル	`["traces","metrics"]`

curl の例

$ curl -n -X PATCH https://api.heroku.com/telemetry-drains/$TELEMETRY_DRAIN_ID \
  -d '{
  "signals": [
    "traces",
    "metrics"
  ],
  "exporter": {
    "type": "otlphttp",
    "endpoint": "https://api.otelproduct.example/consumer",
    "headers": {
      "API-Key": "example_api_key_012345",
      "Environment": "production"
    }
  }
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "created_at": "2024-12-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "owner": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "type": "app"
  },
  "signals": [
    "traces",
    "metrics"
  ],
  "exporter": {
    "type": "otlphttp",
    "endpoint": "https://api.otelproduct.example/consumer",
    "headers": {
      "API-Key": "example_api_key_012345",
      "Environment": "production"
    }
  },
  "updated_at": "2012-01-01T12:00:00Z"
}

テレメトリードレインの削除

テレメトリードレインを削除します。

DELETE /telemetry-drains/{telemetry_drain_id}

curl の例

$ curl -n -X DELETE https://api.heroku.com/telemetry-drains/$TELEMETRY_DRAIN_ID \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "created_at": "2024-12-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "owner": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "type": "app"
  },
  "signals": [
    "traces",
    "metrics"
  ],
  "exporter": {
    "type": "otlphttp",
    "endpoint": "https://api.otelproduct.example/consumer",
    "headers": {
      "API-Key": "example_api_key_012345",
      "Environment": "production"
    }
  },
  "updated_at": "2012-01-01T12:00:00Z"
}

テレメトリードレインの情報

テレメトリードレインに関する情報。

GET /telemetry-drains/{telemetry_drain_id}

curl の例

$ curl -n https://api.heroku.com/telemetry-drains/$TELEMETRY_DRAIN_ID \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "created_at": "2024-12-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "owner": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "type": "app"
  },
  "signals": [
    "traces",
    "metrics"
  ],
  "exporter": {
    "type": "otlphttp",
    "endpoint": "https://api.otelproduct.example/consumer",
    "headers": {
      "API-Key": "example_api_key_012345",
      "Environment": "production"
    }
  },
  "updated_at": "2012-01-01T12:00:00Z"
}

テストケース

安定性: プロトタイプ

テスト実行に属する 1 つのテストケース

属性

名前	型	説明	例
created_at	日時	テストケースが作成された日時	`"2015-01-01T12:00:00Z"`
description	文字列	テストケースの説明	`"example"`
diagnostic	文字列	テストケースに関するメタ情報	`"example"`
directive	文字列	テストケースに関する特殊なメモ (スキップ済み、ToDo など)	`"example"`
id	UUID	テストケースの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
数値	整数	テスト番号	`42`
passed	ブール値	テストケースが成功したかどうか	`true`
test_node:id	文字列	テストノードの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
test_run:id	文字列	テスト実行の一意識別子
updated_at	日時	テストケースが更新された日時	`"2015-01-01T12:00:00Z"`

テストケースの一覧

テストケースを一覧表示します。

Range ヘッダーの唯一の容認可能な順序の値は id です。

GET /test-runs/{test_run_id}/test-cases

curl の例

$ curl -n https://api.heroku.com/test-runs/$TEST_RUN_ID/test-cases \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: id
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "created_at": "2015-01-01T12:00:00Z",
    "updated_at": "2015-01-01T12:00:00Z",
    "description": "example",
    "diagnostic": "example",
    "directive": "example",
    "passed": true,
    "number": 42,
    "test_node": {
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    },
    "test_run": {
      "id": null
    }
  }
]

テストノード

安定性: プロトタイプ

テスト実行に属する 1 つのテストノード

属性

名前	型	説明	例
created_at	日時	テストノードが作成された日時	`"2015-01-01T12:00:00Z"`
dyno	null 許容オブジェクト	このテストノードに属する dyno	`null`
dyno:attach_url	null 許容文字列	デバッグ実行の場合は出力を、デバッグ以外の実行の場合は null をストリーミングするための URL	`"rendezvous://rendezvous.runtime.heroku.com:5000/{rendezvous-id}"`
dyno:id	文字列	この dyno 上のこのプロセスの一意識別子または名前	`"01234567-89ab-cdef-0123-456789abcdef"` または `"run.1"`
error_status	null 許容文字列	エラーが発生したときのテスト実行のステータス	`null`
exit_code	null 許容整数	テストスクリプトの終了コード	`null`
id	文字列	テストノードの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
index	整数	テストノードのインデックス	`42`
message	null 許容文字列	エラーの原因を示す人間が理解できるメッセージ	`null`
output_stream_url	文字列	テストノードのストリーミング出力	`"https://example.com/output.log"`
pipeline:id	文字列	パイプラインの一意識別子または名前	`"01234567-89ab-cdef-0123-456789abcdef"` または `"example"`
setup_stream_url	文字列	テストノードのストリーミングテストのセットアップ出力	`"https://example.com/test-setup.log"`
status	文字列	テスト実行の現在の状態次のうちのいずれか: `"pending"`、`"cancelled"`、`"creating"`、`"building"`、`"running"`、`"succeeded"`、`"failed"`、`"errored"`、`"debugging"`	`"pending"`
test_run:id	文字列	テスト実行の一意識別子
updated_at	日時	テストノードが更新された日時	`"2015-01-01T12:00:00Z"`

テストノードの一覧

テストノードを一覧表示します。

Range ヘッダーの唯一の容認可能な順序の値は id です。

GET /test-runs/{test_run_id}/test-nodes

curl の例

$ curl -n https://api.heroku.com/test-runs/$TEST_RUN_ID/test-nodes \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: id
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "created_at": "2015-01-01T12:00:00Z",
    "dyno": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "attach_url": "rendezvous://rendezvous.runtime.heroku.com:5000/{rendezvous-id}"
    },
    "error_status": "example",
    "exit_code": 42,
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "index": 42,
    "message": "example",
    "output_stream_url": "https://example.com/output.log",
    "pipeline": {
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    },
    "setup_stream_url": "https://example.com/test-setup.log",
    "status": "pending",
    "updated_at": "2015-01-01T12:00:00Z",
    "test_run": {
      "id": null
    }
  }
]

テスト実行

安定性: プロトタイプ

1 つ以上のテストの実行または試行

属性

名前	型	説明	例
actor_email	email	テスト実行をトリガーするアクターのメール	`"username@example.com"`
app_setup	null 許容オブジェクト	テスト実行のためのアプリの設定	`null`
clear_cache	null 許容ブール値	テストが空のキャッシュで実行されたかどうか	`null`
commit_branch	文字列	テスト実行に関連するリポジトリのブランチ	`"example"`
commit_message	文字列	テスト下のコミットのメッセージ	`"example"`
commit_sha	文字列	テスト下のコミットの SHA ハッシュ	`"example"`
created_at	日時	テスト実行が作成された日時	`"2015-01-01T12:00:00Z"`
debug	ブール値	テスト実行が対話型デバッグで開始されたかどうか	`true`
dyno	null 許容オブジェクト	このテスト実行に使用される dyno のタイプ	`null`
dyno:size	文字列	dyno サイズ	`"standard-1X"`
id	UUID	テスト実行の一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
message	null 許容文字列	エラーの原因を示す人間が理解できるメッセージ	`null`
数値	整数	自動増分されるテスト実行番号	`42`
organization	null 許容オブジェクト	このテスト実行を所有するチーム	`null`
organization:name	文字列	チームの一意の名前	`"example"`
pipeline:id	文字列	パイプラインの一意識別子または名前	`"01234567-89ab-cdef-0123-456789abcdef"` または `"example"`
source_blob_url	文字列	テストされるソースコードのダウンロード場所	`"example"`
status	文字列	テスト実行の現在の状態次のうちのいずれか: `"pending"`、`"cancelled"`、`"creating"`、`"building"`、`"running"`、`"succeeded"`、`"failed"`、`"errored"`、`"debugging"`	`"pending"`
updated_at	日時	テスト実行が更新された日時	`"2015-01-01T12:00:00Z"`
user:allow_tracking	ブール値	サードパーティ Web アクティビティの追跡を許可するかどうかデフォルト値: `true`	`true`
user:beta	ブール値	Heroku のベータ機能を利用することが許可されているかどうか	`false`
user:country_of_residence	null 許容文字列	アカウント所有者が存在する国	`"United States"`
user:created_at	日時	アカウントが作成された日時	`"2012-01-01T12:00:00Z"`
user:default_organization	null 許容オブジェクト	デフォルトで選択されるチーム	`null`
user:default_organization:id	UUID	チームの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
user:default_organization:name	文字列	チームの一意の名前	`"example"`
user:default_team	null 許容オブジェクト	デフォルトで選択されるチーム	`null`
user:default_team:id	UUID	チームの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
user:default_team:name	文字列	チームの一意の名前	`"example"`
user:delinquent_at	null 許容日時	アカウントが滞納となった日時	`"2012-01-01T12:00:00Z"`
user:email	メール	一意のメールアドレス	`"username@example.com"`
user:federated	ブール値	ユーザーがフェデレーションされ、ID プロバイダーに属しているかどうか	`false`
user:id	UUID	アカウントの識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
user:identity_provider	null 許容オブジェクト	フェデレーションされているユーザーの ID プロバイダーの詳細	`null`
user:identity_provider:id	UUID	この ID プロバイダーの一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
user:identity_provider:name	文字列	この ID プロバイダーのユーザーにわかりやすい一意識別子	`"acme-sso"`
user:identity_provider:organization:name	文字列	チームの一意の名前	`"example"`
user:identity_provider:owner:id	UUID	所有者の一意識別子	`"01234567-89ab-cdef-0123-456789abcdef"`
user:identity_provider:owner:name	文字列	所有者の名前	`"acme"`
user:identity_provider:owner:type	文字列	所有者のタイプ次のうちのいずれか: `"team"`、`"enterprise-account"`	`"team"`
user:identity_provider:team:name	文字列	チームの一意の名前	`"example"`
user:last_login	null 許容日時	アカウントが Heroku で最後に承認された日時	`"2012-01-01T12:00:00Z"`
user:name	null 許容文字列	アカウント所有者のフルネーム	`"Tina Edmonds"`
user:sms_number	null 許容文字列	アカウントの SMS の番号	`"+1 *-*-1234"`
user:suspended_at	null 許容日時	アカウントが中断された日時	`"2012-01-01T12:00:00Z"`
user:two_factor_authentication	ブール値	アカウントで 2 要素認証が有効になっているかどうか	`false`
user:updated_at	日時	アカウントが更新された日時	`"2012-01-01T12:00:00Z"`
user:verified	ブール値	アカウントが請求情報で確認されているかどうか	`false`
warning_message	null 許容文字列	テスト実行中に送出される人間が理解できる警告	`null`

テスト実行の作成

新しいテスト実行を作成します。

POST /test-runs

必須パラメータ

名前	型	説明	例
commit_branch	文字列	テスト実行に関連するリポジトリのブランチ	`"example"`
commit_message	文字列	テスト下のコミットのメッセージ	`"example"`
commit_sha	文字列	テスト下のコミットの SHA ハッシュ	`"example"`
pipeline	文字列	パイプラインの一意識別子または名前	`"01234567-89ab-cdef-0123-456789abcdef"` または `"example"`
source_blob_url	文字列	テストされるソースコードのダウンロード場所	`"example"`

オプションパラメータ

名前	型	説明	例
debug	ブール値	テスト実行が対話型デバッグで開始されたかどうか	`true`
organization	文字列	チームの一意の名前または識別子	`"example"` または `"01234567-89ab-cdef-0123-456789abcdef"`

curl の例

$ curl -n -X POST https://api.heroku.com/test-runs \
  -d '{
  "commit_branch": "example",
  "commit_message": "example",
  "commit_sha": "example",
  "debug": true,
  "organization": "01234567-89ab-cdef-0123-456789abcdef",
  "pipeline": "01234567-89ab-cdef-0123-456789abcdef",
  "source_blob_url": "example"
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 201 Created
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "actor_email": "username@example.com",
  "clear_cache": true,
  "commit_branch": "example",
  "commit_message": "example",
  "commit_sha": "example",
  "debug": true,
  "app_setup": null,
  "created_at": "2015-01-01T12:00:00Z",
  "dyno": {
    "size": "standard-1X"
  },
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "message": "example",
  "number": 42,
  "organization": {
    "name": "example"
  },
  "pipeline": {
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "status": "pending",
  "source_blob_url": "example",
  "updated_at": "2015-01-01T12:00:00Z",
  "user": {
    "allow_tracking": true,
    "beta": false,
    "created_at": "2012-01-01T12:00:00Z",
    "email": "username@example.com",
    "federated": false,
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "identity_provider": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "acme-sso",
      "team": {
        "name": "example"
      },
      "organization": {
        "name": "example"
      },
      "owner": {
        "id": "01234567-89ab-cdef-0123-456789abcdef",
        "name": "acme",
        "type": "team"
      }
    },
    "last_login": "2012-01-01T12:00:00Z",
    "name": "Tina Edmonds",
    "sms_number": "+1 ***-***-1234",
    "suspended_at": "2012-01-01T12:00:00Z",
    "delinquent_at": "2012-01-01T12:00:00Z",
    "two_factor_authentication": false,
    "updated_at": "2012-01-01T12:00:00Z",
    "verified": false,
    "country_of_residence": "United States",
    "default_organization": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "example"
    },
    "default_team": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "example"
    }
  },
  "warning_message": "example"
}

テスト実行の情報

既存のテスト実行に関する情報。

GET /test-runs/{test_run_id}

curl の例

$ curl -n https://api.heroku.com/test-runs/$TEST_RUN_ID \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "actor_email": "username@example.com",
  "clear_cache": true,
  "commit_branch": "example",
  "commit_message": "example",
  "commit_sha": "example",
  "debug": true,
  "app_setup": null,
  "created_at": "2015-01-01T12:00:00Z",
  "dyno": {
    "size": "standard-1X"
  },
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "message": "example",
  "number": 42,
  "organization": {
    "name": "example"
  },
  "pipeline": {
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "status": "pending",
  "source_blob_url": "example",
  "updated_at": "2015-01-01T12:00:00Z",
  "user": {
    "allow_tracking": true,
    "beta": false,
    "created_at": "2012-01-01T12:00:00Z",
    "email": "username@example.com",
    "federated": false,
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "identity_provider": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "acme-sso",
      "team": {
        "name": "example"
      },
      "organization": {
        "name": "example"
      },
      "owner": {
        "id": "01234567-89ab-cdef-0123-456789abcdef",
        "name": "acme",
        "type": "team"
      }
    },
    "last_login": "2012-01-01T12:00:00Z",
    "name": "Tina Edmonds",
    "sms_number": "+1 ***-***-1234",
    "suspended_at": "2012-01-01T12:00:00Z",
    "delinquent_at": "2012-01-01T12:00:00Z",
    "two_factor_authentication": false,
    "updated_at": "2012-01-01T12:00:00Z",
    "verified": false,
    "country_of_residence": "United States",
    "default_organization": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "example"
    },
    "default_team": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "example"
    }
  },
  "warning_message": "example"
}

テスト実行の一覧

パイプラインの既存のテスト実行を一覧表示します。

Range ヘッダーの唯一の容認可能な順序の値は id です。

GET /pipelines/{pipeline_id}/test-runs

curl の例

$ curl -n https://api.heroku.com/pipelines/$PIPELINE_ID/test-runs \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: id
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "actor_email": "username@example.com",
    "clear_cache": true,
    "commit_branch": "example",
    "commit_message": "example",
    "commit_sha": "example",
    "debug": true,
    "app_setup": null,
    "created_at": "2015-01-01T12:00:00Z",
    "dyno": {
      "size": "standard-1X"
    },
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "message": "example",
    "number": 42,
    "organization": {
      "name": "example"
    },
    "pipeline": {
      "id": "01234567-89ab-cdef-0123-456789abcdef"
    },
    "status": "pending",
    "source_blob_url": "example",
    "updated_at": "2015-01-01T12:00:00Z",
    "user": {
      "allow_tracking": true,
      "beta": false,
      "created_at": "2012-01-01T12:00:00Z",
      "email": "username@example.com",
      "federated": false,
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "identity_provider": {
        "id": "01234567-89ab-cdef-0123-456789abcdef",
        "name": "acme-sso",
        "team": {
          "name": "example"
        },
        "organization": {
          "name": "example"
        },
        "owner": {
          "id": "01234567-89ab-cdef-0123-456789abcdef",
          "name": "acme",
          "type": "team"
        }
      },
      "last_login": "2012-01-01T12:00:00Z",
      "name": "Tina Edmonds",
      "sms_number": "+1 ***-***-1234",
      "suspended_at": "2012-01-01T12:00:00Z",
      "delinquent_at": "2012-01-01T12:00:00Z",
      "two_factor_authentication": false,
      "updated_at": "2012-01-01T12:00:00Z",
      "verified": false,
      "country_of_residence": "United States",
      "default_organization": {
        "id": "01234567-89ab-cdef-0123-456789abcdef",
        "name": "example"
      },
      "default_team": {
        "id": "01234567-89ab-cdef-0123-456789abcdef",
        "name": "example"
      }
    },
    "warning_message": "example"
  }
]

パイプラインごとのテスト実行の情報

パイプラインごとの既存のテスト実行に関する情報。

GET /pipelines/{pipeline_id}/test-runs/{test_run_number}

curl の例

$ curl -n https://api.heroku.com/pipelines/$PIPELINE_ID/test-runs/$TEST_RUN_NUMBER \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "actor_email": "username@example.com",
  "clear_cache": true,
  "commit_branch": "example",
  "commit_message": "example",
  "commit_sha": "example",
  "debug": true,
  "app_setup": null,
  "created_at": "2015-01-01T12:00:00Z",
  "dyno": {
    "size": "standard-1X"
  },
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "message": "example",
  "number": 42,
  "organization": {
    "name": "example"
  },
  "pipeline": {
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "status": "pending",
  "source_blob_url": "example",
  "updated_at": "2015-01-01T12:00:00Z",
  "user": {
    "allow_tracking": true,
    "beta": false,
    "created_at": "2012-01-01T12:00:00Z",
    "email": "username@example.com",
    "federated": false,
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "identity_provider": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "acme-sso",
      "team": {
        "name": "example"
      },
      "organization": {
        "name": "example"
      },
      "owner": {
        "id": "01234567-89ab-cdef-0123-456789abcdef",
        "name": "acme",
        "type": "team"
      }
    },
    "last_login": "2012-01-01T12:00:00Z",
    "name": "Tina Edmonds",
    "sms_number": "+1 ***-***-1234",
    "suspended_at": "2012-01-01T12:00:00Z",
    "delinquent_at": "2012-01-01T12:00:00Z",
    "two_factor_authentication": false,
    "updated_at": "2012-01-01T12:00:00Z",
    "verified": false,
    "country_of_residence": "United States",
    "default_organization": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "example"
    },
    "default_team": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "example"
    }
  },
  "warning_message": "example"
}

テスト実行の更新

テスト実行のステータスを更新します。

PATCH /test-runs/{test_run_number}

必須パラメータ

名前	型	説明	例
message	null 許容文字列	エラーの原因を示す人間が理解できるメッセージ	`null`
status	文字列	テスト実行の現在の状態次のうちのいずれか: `"pending"`、`"cancelled"`、`"creating"`、`"building"`、`"running"`、`"succeeded"`、`"failed"`、`"errored"`、`"debugging"`	`"pending"`

curl の例

$ curl -n -X PATCH https://api.heroku.com/test-runs/$TEST_RUN_NUMBER \
  -d '{
  "status": "pending",
  "message": "example"
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "actor_email": "username@example.com",
  "clear_cache": true,
  "commit_branch": "example",
  "commit_message": "example",
  "commit_sha": "example",
  "debug": true,
  "app_setup": null,
  "created_at": "2015-01-01T12:00:00Z",
  "dyno": {
    "size": "standard-1X"
  },
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "message": "example",
  "number": 42,
  "organization": {
    "name": "example"
  },
  "pipeline": {
    "id": "01234567-89ab-cdef-0123-456789abcdef"
  },
  "status": "pending",
  "source_blob_url": "example",
  "updated_at": "2015-01-01T12:00:00Z",
  "user": {
    "allow_tracking": true,
    "beta": false,
    "created_at": "2012-01-01T12:00:00Z",
    "email": "username@example.com",
    "federated": false,
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "identity_provider": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "acme-sso",
      "team": {
        "name": "example"
      },
      "organization": {
        "name": "example"
      },
      "owner": {
        "id": "01234567-89ab-cdef-0123-456789abcdef",
        "name": "acme",
        "type": "team"
      }
    },
    "last_login": "2012-01-01T12:00:00Z",
    "name": "Tina Edmonds",
    "sms_number": "+1 ***-***-1234",
    "suspended_at": "2012-01-01T12:00:00Z",
    "delinquent_at": "2012-01-01T12:00:00Z",
    "two_factor_authentication": false,
    "updated_at": "2012-01-01T12:00:00Z",
    "verified": false,
    "country_of_residence": "United States",
    "default_organization": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "example"
    },
    "default_team": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "example"
    }
  },
  "warning_message": "example"
}

ユーザー設定

安定性: 本番環境

ユーザーの設定とメッセージの破棄を追跡します。

属性

名前	型	説明	例
default-organization	null 許容文字列	ユーザーのデフォルトチーム	`"sushi-inc"`
dismissed-getting-started	null 許容ブール値	ユーザーがはじめにのバナーを破棄したかどうか	`true`
dismissed-github-banner	null 許容ブール値	ユーザーが GitHub リンクのバナーを破棄したかどうか	`true`
dismissed-org-access-controls	null 許容ブール値	ユーザーが組織アクセス制御のバナーを破棄したかどうか	`true`
dismissed-org-wizard-notification	null 許容ブール値	ユーザーが組織ウィザードを破棄したかどうか	`true`
dismissed-pipelines-banner	null 許容ブール値	ユーザーがパイプラインのバナーを破棄したかどうか	`true`
dismissed-pipelines-github-banner	null 許容ブール値	ユーザーがパイプラインの概要に関する GitHub のバナーを破棄したかどうか	`true`
dismissed-pipelines-github-banners	null 許容配列	ユーザーが GitHub のバナーを破棄したパイプライン UUID	`["96c68759-f310-4910-9867-e0b062064098"]`
dismissed-sms-banner	null 許容ブール値	ユーザーが 2FA SMS のバナーを破棄したかどうか	`true`
timezone	null 許容文字列	ユーザーのデフォルトのタイムゾーン	`"UTC"`

ユーザー設定の一覧

ユーザー設定を取得します。

GET /users/{user_preferences_self}/preferences

curl の例

$ curl -n https://api.heroku.com/users/$USER_PREFERENCES_SELF/preferences \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "timezone": "UTC",
  "default-organization": "sushi-inc",
  "dismissed-github-banner": true,
  "dismissed-getting-started": true,
  "dismissed-org-access-controls": true,
  "dismissed-org-wizard-notification": true,
  "dismissed-pipelines-banner": true,
  "dismissed-pipelines-github-banner": true,
  "dismissed-pipelines-github-banners": [
    "96c68759-f310-4910-9867-e0b062064098"
  ],
  "dismissed-sms-banner": true
}

ユーザー設定の更新

ユーザー設定を更新します。

PATCH /users/{user_preferences_self}/preferences

オプションパラメータ

名前	型	説明	例
default-organization	null 許容文字列	ユーザーのデフォルトチーム	`"sushi-inc"`
dismissed-getting-started	null 許容ブール値	ユーザーがはじめにのバナーを破棄したかどうか	`true`
dismissed-github-banner	null 許容ブール値	ユーザーが GitHub リンクのバナーを破棄したかどうか	`true`
dismissed-org-access-controls	null 許容ブール値	ユーザーが組織アクセス制御のバナーを破棄したかどうか	`true`
dismissed-org-wizard-notification	null 許容ブール値	ユーザーが組織ウィザードを破棄したかどうか	`true`
dismissed-pipelines-banner	null 許容ブール値	ユーザーがパイプラインのバナーを破棄したかどうか	`true`
dismissed-pipelines-github-banner	null 許容ブール値	ユーザーがパイプラインの概要に関する GitHub のバナーを破棄したかどうか	`true`
dismissed-pipelines-github-banners	null 許容配列	ユーザーが GitHub のバナーを破棄したパイプライン UUID	`["96c68759-f310-4910-9867-e0b062064098"]`
dismissed-sms-banner	null 許容ブール値	ユーザーが 2FA SMS のバナーを破棄したかどうか	`true`
timezone	null 許容文字列	ユーザーのデフォルトのタイムゾーン	`"UTC"`

curl の例

$ curl -n -X PATCH https://api.heroku.com/users/$USER_PREFERENCES_SELF/preferences \
  -d '{
  "timezone": "UTC",
  "default-organization": "sushi-inc",
  "dismissed-github-banner": true,
  "dismissed-getting-started": true,
  "dismissed-org-access-controls": true,
  "dismissed-org-wizard-notification": true,
  "dismissed-pipelines-banner": true,
  "dismissed-pipelines-github-banner": true,
  "dismissed-pipelines-github-banners": [
    "96c68759-f310-4910-9867-e0b062064098"
  ],
  "dismissed-sms-banner": true
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "timezone": "UTC",
  "default-organization": "sushi-inc",
  "dismissed-github-banner": true,
  "dismissed-getting-started": true,
  "dismissed-org-access-controls": true,
  "dismissed-org-wizard-notification": true,
  "dismissed-pipelines-banner": true,
  "dismissed-pipelines-github-banner": true,
  "dismissed-pipelines-github-banners": [
    "96c68759-f310-4910-9867-e0b062064098"
  ],
  "dismissed-sms-banner": true
}

Private Spaces VPN

安定性: 本番環境

VPN は、Private Spaces を VPN 経由でネットワークに接続するための方法を提供します。

属性

名前	型	説明	例
id	文字列	VPN ID	`"123456789012"`
ike_version	整数	IKE バージョン	`1`
name	文字列	VPN 名	`"office"`
public_ip	文字列	VPN 顧客ゲートウェイのパブリック IP	`"35.161.69.30"`
routable_cidrs	配列	VPN のルーティング可能な CIDR	`["172.16.0.0/16"]`
space_cidr_block	文字列	Private Space の CIDR ブロック	`"10.0.0.0/16"`
status	文字列	VPN のステータス次のうちのいずれか: `"pending"`、`"provisioning"`、`"active"`、`"deprovisioning"`、`"failed"`	`"active"`
status_message	文字列	ステータスの詳細	`"supplied CIDR block already in use"`
tunnels	配列		`[{"last_status_change":"2016-10-25T22:09:05Z","ip":"52.44.146.197","customer_ip":"52.44.146.197","pre_shared_key":"secret","status":"UP","status_message":"status message"}]`

Private Spaces VPN の作成

Private Space 内に新しい VPN 接続を作成します。

POST /spaces/{space_id_or_name}/vpn-connections

必須パラメータ

名前	型	説明	例
name	文字列	VPN 名	`"office"`
public_ip	文字列	VPN 顧客ゲートウェイのパブリック IP	`"35.161.69.30"`
routable_cidrs	配列	VPN のルーティング可能な CIDR	`["172.16.0.0/16"]`

curl の例

$ curl -n -X POST https://api.heroku.com/spaces/$SPACE_ID_OR_NAME/vpn-connections \
  -d '{
  "name": "office",
  "public_ip": "35.161.69.30",
  "routable_cidrs": [
    "172.16.0.0/16"
  ]
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 201 Created
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "id": "123456789012",
  "name": "office",
  "public_ip": "35.161.69.30",
  "routable_cidrs": [
    "172.16.0.0/16"
  ],
  "space_cidr_block": "10.0.0.0/16",
  "tunnels": [
    {
      "last_status_change": "2016-10-25T22:09:05Z",
      "ip": "52.44.146.197",
      "customer_ip": "52.44.146.197",
      "pre_shared_key": "secret",
      "status": "UP",
      "status_message": "status message"
    }
  ],
  "ike_version": 1,
  "status": "active",
  "status_message": "supplied CIDR block already in use"
}

Private Spaces VPN の破棄

既存の VPN 接続を破棄します。

DELETE /spaces/{space_id_or_name}/vpn-connections/{vpn_connection_id_or_name}

curl の例

$ curl -n -X DELETE https://api.heroku.com/spaces/$SPACE_ID_OR_NAME/vpn-connections/$VPN_CONNECTION_ID_OR_NAME \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 202 Accepted
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

Private Spaces VPN の一覧

Space の VPN 接続を一覧表示します。

Range ヘッダーの容認可能な順序の値は id または name です。

GET /spaces/{space_id_or_name}/vpn-connections

curl の例

$ curl -n https://api.heroku.com/spaces/$SPACE_ID_OR_NAME/vpn-connections \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
Accept-Ranges: id, name
Content-Range: id 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

[
  {
    "id": "123456789012",
    "name": "office",
    "public_ip": "35.161.69.30",
    "routable_cidrs": [
      "172.16.0.0/16"
    ],
    "space_cidr_block": "10.0.0.0/16",
    "tunnels": [
      {
        "last_status_change": "2016-10-25T22:09:05Z",
        "ip": "52.44.146.197",
        "customer_ip": "52.44.146.197",
        "pre_shared_key": "secret",
        "status": "UP",
        "status_message": "status message"
      }
    ],
    "ike_version": 1,
    "status": "active",
    "status_message": "supplied CIDR block already in use"
  }
]

Private Spaces VPN の情報

既存の VPN 接続に関する情報。

GET /spaces/{space_id_or_name}/vpn-connections/{vpn_connection_id_or_name}

curl の例

$ curl -n https://api.heroku.com/spaces/$SPACE_ID_OR_NAME/vpn-connections/$VPN_CONNECTION_ID_OR_NAME \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "id": "123456789012",
  "name": "office",
  "public_ip": "35.161.69.30",
  "routable_cidrs": [
    "172.16.0.0/16"
  ],
  "space_cidr_block": "10.0.0.0/16",
  "tunnels": [
    {
      "last_status_change": "2016-10-25T22:09:05Z",
      "ip": "52.44.146.197",
      "customer_ip": "52.44.146.197",
      "pre_shared_key": "secret",
      "status": "UP",
      "status_message": "status message"
    }
  ],
  "ike_version": 1,
  "status": "active",
  "status_message": "supplied CIDR block already in use"
}

Private Spaces VPN の更新

Private Space 内で VPN 接続を更新します。

PATCH /spaces/{space_id_or_name}/vpn-connections/{vpn_connection_id_or_name}

必須パラメータ

名前	型	説明	例
routable_cidrs	配列	VPN のルーティング可能な CIDR	`["172.16.0.0/16"]`

curl の例

$ curl -n -X PATCH https://api.heroku.com/spaces/$SPACE_ID_OR_NAME/vpn-connections/$VPN_CONNECTION_ID_OR_NAME \
  -d '{
  "routable_cidrs": [
    "172.16.0.0/16"
  ]
}' \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.heroku+json; version=3"

応答の例

HTTP/1.1 200 OK
ETag: "0123456789abcdef0123456789abcdef"
Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT
RateLimit-Remaining: 4500

{
  "id": "123456789012",
  "name": "office",
  "public_ip": "35.161.69.30",
  "routable_cidrs": [
    "172.16.0.0/16"
  ],
  "space_cidr_block": "10.0.0.0/16",
  "tunnels": [
    {
      "last_status_change": "2016-10-25T22:09:05Z",
      "ip": "52.44.146.197",
      "customer_ip": "52.44.146.197",
      "pre_shared_key": "secret",
      "status": "UP",
      "status_message": "status message"
    }
  ],
  "ike_version": 1,
  "status": "active",
  "status_message": "supplied CIDR block already in use"
}

Keep Reading

Or explore the Platform API category.

Categories

Platform API リファレンス

Table of Contents [expand]

概要

認証

キャッシング

クライアント

CORS

スキーマ

cURL の例

カスタムの型

データの整合性

エラー

エラー属性

エラー応答

エスケープ

メソッド

メソッドの上書き

パラメータ

範囲

速度制限

リクエスト ID

応答

応答ヘッダー

安定性

ステータス

成功した応答

エラー応答

​クライアントエラーの応答

​Heroku エラーの応答

バージョン管理

​アカウント

属性

アカウントの情報

curl の例

応答の例

アカウントの更新

オプションパラメータ

curl の例

応答の例

アカウントの削除

curl の例

応答の例

ユーザーごとのアカウント情報

curl の例

応答の例

ユーザーごとのアカウントの更新

オプションパラメータ

curl の例

応答の例

ユーザーごとのアカウントの削除

curl の例

応答の例

​アカウントの義務不履行

属性

アカウントの義務不履行情報

curl の例

応答の例

​アカウント機能

属性

アカウント機能の情報

curl の例

応答の例

アカウント機能の一覧

curl の例

応答の例

アカウント機能の更新

必須パラメータ

curl の例

応答の例

​アドオン

属性

アドオンの一覧

curl の例

応答の例

アドオンの情報

curl の例

応答の例

アドオンの作成

必須パラメータ

クライアントエラーの応答

Heroku エラーの応答

アカウント

アカウントの義務不履行

アカウント機能

アドオン

アドオンアクション

アドオンアタッチメント

アドオン設定